updateSale

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

Annotations indicate destructive and idempotent; description adds that only passed fields are replaced and that updating gift options in specific payments triggers automatic charge/refund. No contradiction with annotations.

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 concise, front-loaded with main purpose, then details replacement behavior, payment special cases, and sibling references. Every sentence adds value without redundancy.

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?

Given the tool's complexity (nested object, many fields), the description covers core use cases, partial update, and payment-specific behaviors. No output schema is provided, but return value is not critical for usage. References to siblings complete the context.

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?

Despite 0% schema description coverage top-level, the description explains the partial update mechanism (only passed fields) and mentions sale_id as identifier. The schema itself provides detailed nested field descriptions, so the description adds meaningful context without repeating schema.

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 clearly states the tool is for post-order delivery address correction, memo addition, state transition, and fee adjustment. It distinguishes from siblings by explicitly naming cancelSale, getSale, and sendSalesMail for other operations.

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?

Provides explicit when-to-use context (post-order corrections) and when-not-to-use (cancellation, details, email) by referencing sibling tools. Also notes special behavior for specific payment types.

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