Skip to main content
Glama
@cmssy/mcp-server

@cmssy/mcp-server

Official

Update sales channel

update_sales_channel
Destructive

Change a sales channel's name, display mode, price access or currency without altering its key. Use it to rename a channel or restrict who sees prices and can check out.

Instructions

Rename a sales channel or change its displayMode, priceAccess or currency. The key cannot change. Changing the currency abandons the carts open on the channel - check activeCartCount first. Narrowing priceAccess refuses carts and checkout to buyers who no longer qualify; their carts are kept and come back if access returns. Which lists price the channel is changed on the price list (update_price_list channels).

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": "update_sales_channel"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe sales channel's id (from list_sales_channels)
nameNoNew display name
currencyNoOmit to keep it; null or the default currency sells in the default currency, else one of the workspace's additional currencies. A change abandons the channel's open carts (activeCartCount)
displayModeNoHow visitors and customers without a company read the channel's prices: net (VAT added on top) or gross (VAT inside). Default gross; a company buyer keeps their company's mode.
priceAccessNoWho sees the channel's prices and may buy through it: PUBLIC - anyone (default); MEMBERS - signed-in customers, and registration is open; COMPANY_MEMBERS - buyers of an approved company, the one to use for trade prices. Others get prices withheld and carts refused.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.73.2

TDQS

A4.3/5.0
Behavior5/5

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

Annotations only declare destructiveHint=true; the description goes well past that by naming the two destructive side effects precisely: a currency change abandons open carts, and narrowing priceAccess refuses carts and checkout to no-longer-qualifying buyers. It also discloses recovery behavior ('their carts are kept and come back if access returns'), which is exactly the risk context an agent needs before mutating a channel.

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?

Four sentences, front-loaded with purpose then the two consequences, with zero filler or boilerplate. Slight redundancy with the schema's own parameter descriptions keeps it from a 5.

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?

Covers the mutation's real-world fallout (carts, checkout access, immutable key) for a five-parameter tool with no output schema, and destructive semantics are fully surfaced. It does not state permission/auth requirements or explicitly confirm that omitted optional fields are preserved, which is the only material gap.

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 coverage is 100% and the schema descriptions already explain the currency cart-abandonment, the net/gross displayMode semantics and each priceAccess level, so most of the description's parameter text restates structured data. It does add ordering advice (check activeCartCount first) and the immutability of id, which is marginal value beyond the schema, hence baseline 3.

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?

States a specific verb (rename/change) and resource (sales channel) plus the exact mutable fields: name, displayMode, priceAccess, currency. It also states an invariant ('The key cannot change'), so an agent immediately knows the id is immutable and can distinguish this from create/delete_sales_channel.

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?

Gives an explicit precondition for the risky path ('Changing the currency... check activeCartCount first') and routes a related concern elsewhere ('Which lists price the channel is changed on the price list (update_price_list channels)'). It stops short of naming when to prefer delete_sales_channel or create_sales_channel, but for a standard update tool that gap is minor.

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