cancel_consignment

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

No annotations are present, so the description carries the full burden. It discloses one behavioral condition (status restriction) but does not mention side effects like permanent deletion, reversal options, or permissions. For a cancel operation, it is moderately transparent.

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 extremely concise with two sentences; the first clearly states the purpose and the second adds a critical condition. There is no redundancy, and every word contributes 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?

Given that an output schema exists, return values are not needed. The description covers the core purpose and a key condition, but lacks parameter guidance and behavioral context (e.g., what happens on cancel). For a simple tool, it is minimally adequate.

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 description coverage is 0%, meaning parameter descriptions are missing in the schema. The tool description does not refer to either parameter ('code' or 'reason'), so it adds no meaning beyond the schema's type and required status. This is a significant gap.

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 verb 'Cancel' and the resource 'consignment', and adds a specific condition about status ('Only works for draft/confirmed status'), which distinguishes it from sibling tools like 'cancel_order' or 'create_consignment'.

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 explicitly indicates when the tool is applicable (only for draft/confirmed status), providing a clear usage context. It does not list alternatives or when not to use it, but the constraint is sufficient for an AI agent to decide.

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