cancel_order

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

No annotations are provided, so the description must disclose behavioral traits. It reveals that the tool requires API credentials (authentication needs) and has a safety guard against accidental mass cancellation. This adds useful context beyond the schema, though it could mention side effects or return values.

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 (3 sentences) and front-loaded with the main action. Every sentence provides necessary information without redundancy. No fluff or extraneous details.

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 3 parameters, no output schema, and no annotations, the description covers the core use cases, safety constraints, and authentication. It lacks details on return values or error handling, but for a cancellation tool, the provided information is fairly complete for an agent to understand correct invocation.

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%, with each parameter described in the input schema. The description adds value by explaining the interplay between parameters: 'order_id' vs 'cancel_all', and that 'market_id' is required for single order cancel but optional with 'cancel_all'. This clarifies conditional requirements beyond the schema descriptions.

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 cancels a resting order, and distinguishes between single-order and mass cancellation with specific parameter requirements. It uses precise verbs ('cancel') and identifies the resource ('resting order'), making its purpose unambiguous and distinct from siblings like 'amend_order' or 'place_order'.

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?

Explicit guidance is provided on when to use each mode: pass 'order_id' for single cancel, or 'cancel_all: true' for mass cancel. It warns that an empty call is rejected to prevent accidental mass cancellation. However, it does not explicitly state when not to use the tool (e.g., for modifying orders) or mention alternatives.

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