Update sales channel

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

Annotations already indicate a destructive write operation, and the description adds the critical nuance that passing null clears a value. It also clarifies that the url parameter is exposed as the channel domain, giving useful behavioral detail beyond the structured hints.

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

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

Two sentences, front-loaded with the action, followed by the exact fields affected and the null-clearing behavior. Every sentence contributes useful information with no filler or repetition.

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

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

For a straightforward update tool, the description covers what can be changed and how to clear values, while the schema supplies the required IDs. No output schema exists, so return values are not described, but this is a minor gap for a simple mutation.

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

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

Schema coverage is 100%, so the parameters are already well documented. The description adds one meaningful extra semantic: the public url is 'returned as the channel domain,' which helps an agent correlate request and response naming. The rest mostly reinforces the schema's existing null-clearing behavior.

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

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

The description opens with a specific verb and resource: 'Update a custom sales channel.' It clarifies which fields are mutable (name and url) and is clearly distinct from siblings like ecommerce_createASalesChannelV1 or ecommerce_listSalesChannelsV1.

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

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

The description implies the tool is for changing an existing sales channel's name or URL, but it does not explicitly state when to use this tool over the create or list siblings, nor does it mention prerequisites such as store ownership. The usage context is present but only by implication.

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