clm_shipment_command_discard_shipment

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

The destructiveHint annotation is enriched with precise behavioral detail: in-progress wizard drafts are fully deleted, while submitted shipments only have their pending edit draft and smart-wizard draft cleared. This clearly discloses what gets destroyed and what remains intact, going beyond the annotation.

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 sentence with no filler. It front-loads the core action and uses a conditional structure to compactly convey the two distinct outcomes.

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?

The description is largely complete for a destructive command: it explains the two relevant shipment states, what is deleted, and what is preserved. Minor gaps remain, such as how to handle a null ShipmentId or what error behavior occurs when the shipment does not exist.

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% and the description does not explicitly reference the ShipmentId parameter or explain its semantics. A single parameter is easy to infer, but the description fails to address the nullable default or confirm that a valid ShipmentId must be provided for the discard to take effect.

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?

States a specific verb and resource: 'Discards a shipment.' It also distinguishes behavior by shipment state, which differentiates it from siblings like delete_draft_shipment by clarifying when full deletion happens versus clearing only a pending edit draft.

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 intended context is implied through the state-dependent behavior: use when you want to discard a shipment or its pending edits. However, the description never explicitly guides the agent on when to prefer this over alternatives such as delete_draft_shipment, nor does it mention exclusions or prerequisites.

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