cancelSale

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

Discloses irreversibility, that order quantities and total become zero, canceled flag becomes true, points and payments are automatically refunded, and sales fee becomes zero if not yet determined. This adds significant context beyond annotations, which only indicate mutability and idempotency.

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?

The description is a single paragraph efficiently covering the main action, consequences, limitations, and alternatives. Every sentence adds value, and the most important information is front-loaded.

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?

Despite no output schema, the description fully explains outcomes (quantities zero, canceled flag, automatic refunds), unsupported cases, and irreversibility. Parameters are well-covered, and sibling tools are mentioned for related operations.

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 covers 50% of parameters with descriptions (only restock). The description adds meaning: restock specifies whether to automatically restock inventory. sale_id is identified as the target, compensating for its lack of schema 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?

Description clearly states it cancels an existing order and triggers returns/refunds, specifying the target via sale_id and the restock parameter. It distinguishes itself from sibling tools like updateSale and getSale by noting updates and details are handled elsewhere.

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?

Explicitly describes when to use (cancel orders), when not to use (split orders, credit card with cancel linkage), and lists alternatives (updateSale for updates, getSale for details). Also mentions unsupported scenarios.

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