Skip to main content
Glama

List sales channels

sales_channels_list
Read-onlyIdempotent

List sales channels with type, domains, and active status to identify which storefront, headless API, or marketplace an order or product belongs to.

Instructions

List sales channels (storefronts, headless APIs, marketplaces) with their type, domains and active flag. Use it to find the sales channel or domain an order or product belongs to. Returns { total, page, limit, items[] }.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sales_channels_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo1-based page
sortNoSort order; defaults per tool
termNoFull-text search term
limitNoItems per page, max 50 (default from SHOPWARE_MCP_DEFAULT_LIMIT)
fieldsNoExtra raw entity fields to add to each item, e.g. ['customFields', 'ean']. Dot-paths allowed.
filterNoCriteria filters, combined with AND

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.11.1

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly, idempotent, non-destructive and openWorld, so the safety profile is covered. The description adds value beyond them by stating the envelope shape { total, page, limit, items[] }, which matters because there is no output schema; it does not discuss pagination limits or sort defaults, but those live in the schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, both front-loaded: what is listed and what each item carries first, then the use case, then the return shape. Nothing is redundant with the title or the schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a six-parameter, zero-required, read-only list tool with a fully documented schema, the description covers purpose, trigger and return envelope. It could do slightly more for the openWorld flag by noting that channels are shop-scoped, but nothing essential to calling it is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with page, limit, term, sort, fields and filter all documented in the schema itself. The description adds no parameter-level meaning (no guidance on which filter fields exist for channels, or on term semantics), so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description pairs a specific verb (List) with a specific resource (sales channels) and immediately enumerates what a channel is — storefronts, headless APIs, marketplaces — plus the fields returned (type, domains, active flag). An agent can tell this apart from storefront_search or products_search because the description frames it as the channel/domain lookup layer.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"Use it to find the sales channel or domain an order or product belongs to" gives a concrete trigger condition, which is more than most list tools offer. It stops short of naming alternatives or stating when not to use it (e.g. when you already have a channel ID and want the full entity), so it is clear context without exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.