Cancel Shipment Order

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

The description discloses that this is a destructive state change, which aligns with the destructiveHint annotation, and mentions the return result. However, it adds little beyond the annotations, and the additional_fields note is more parameter semantics than behavioral context.

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 compact, front-loaded with the main action, and uses a clear Args/Returns structure. Every sentence contributes value, including the note about cross-checking and additional_fields.

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 no output schema, the description covers the required identifier, optional parameters, and the return value at a high level. It lacks details about preconditions (e.g., cannot cancel shipped orders) and consequences beyond 'destructive', but the annotations provide safety 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?

The description explains each parameter's purpose, including clarifying that shipmentOrderCode is for cross-checking and listing example additional_fields. This goes beyond the schema, which omits a description for shipmentOrderCode.

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 'Cancel a shipment order by its identifier (UUID)' with a specific verb and resource, clearly distinguishing it from siblings like cancel_return_order and get_shipment_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?

The description clearly implies when to use this tool (to cancel a shipment order) and provides clear context. It does not explicitly mention alternatives or exclusions, but the tool name and sibling list make the intended scope obvious.

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