Skip to main content
Glama
@cmssy/mcp-server

@cmssy/mcp-server

Official

Get sales channel

get_sales_channel
Read-only

Retrieve one sales channel by ID to inspect its pricing, active price list, published lists, next change time, and open cart count before deleting or editing.

Instructions

Get one sales channel by id: key, name, displayMode, priceAccess, activePriceList (the dated list whose window holds now, else the base list), priceLists published to it with their windows, nextChangeAt and activeCartCount (open carts a delete would abandon). Read-only.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

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

Input Schema

NameRequiredDescriptionDefault
idYesThe sales channel's id (from list_sales_channels)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.73.2

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so "Read-only" adds nothing. The description does add real behavioral context beyond the annotations: it defines how activePriceList resolves (dated window holding now, else base list) and explains activeCartCount as open carts a delete would abandon, which signals delete risk. It says nothing about what happens when the id is unknown or about pagination/size of priceLists.

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

Conciseness4/5

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

It is front-loaded with the verb and resource, and every clause carries information an agent cannot get from the schema or annotations. The long parenthetical field list makes it a dense run-on, but trimming any of it would lose real return-value semantics.

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?

With no output schema, the description properly carries the burden of explaining return values, and it does so field by field, including the non-obvious derived values. Only the not-found/error behavior and any size limits on priceLists are left unspecified.

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?

Only one parameter with 100% schema description coverage, including the hint that ids come from list_sales_channels, so the baseline is 3. The description's "by id" restates the schema rather than adding format, sourcing, or error semantics.

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

Purpose4/5

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

"Get one sales channel by id" states a specific verb, resource, and singular scope, which separates it from list_sales_channels. The description then enumerates the returned fields (key, name, displayMode, priceAccess, priceLists, nextChangeAt, activeCartCount), so an agent knows exactly what it gets. It stops short of explicitly naming the list sibling as the alternative.

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

Usage Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance; the agent must infer that this is for fetching a single channel when the id is already known (the schema hint points at list_sales_channels, not the description). No prerequisites, no mention of how it relates to get_price_list or the update/delete siblings.

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

Deploy Server

Other Tools