Cancel an order

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

Annotations already declare readOnlyHint=false and destructiveHint=false. The description adds useful context by noting the optional customer email and that the updated order summary is returned, but it does not disclose irreversibility, failure conditions, or permission needs.

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 short sentences, front-loaded with the primary action and no filler. Every clause contributes useful information about the operation, side effect, or return value.

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 low-complexity tool, the description covers the core operation, optional notification, and return value, which is enough to make a basic call correctly. It would be richer with a note about order state constraints, but nothing essential is missing.

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?

The input schema fully documents all three parameters with 100% coverage, so the description does not need to repeat them. The description adds only that emailing is optional, which is already captured by the notify_customer parameter description.

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 states the exact operation, 'Cancel the order', and identifies the resource (an order) plus an optional side effect (emailing the customer). It is clearly distinguished from sibling tools like ecommerce_fulfilAnOrderV1, ecommerce_retrieveAnOrderV1, and ecommerce_listStoreOrdersV1.

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?

No explicit guidance is given on when to use this tool, when not to use it, or what alternatives exist. Usage is only implied by the verb 'cancel', with no mention of prerequisites such as order state or restrictions on cancelling fulfilled/already-cancelled orders.

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