Ship a batch

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

The description adds important behavioral context beyond the destructiveHint annotation: 'THIS CHARGES YOUR BALANCE for every item in the batch.' It also mentions asynchronous processing, which is not captured in annotations. This provides transparency on cost and execution flow.

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 uses three sentences, each with distinct value: purpose, prerequisite, cost/async behavior. It is front-loaded with the core action. No unnecessary words.

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 pragmatically addresses the key aspects: status requirement, cost, confirmation flag, and polling guidance. It is adequate for an agent to correctly invoke and follow up on this operation.

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 input schema covers both parameters with descriptions (100% coverage). The description alludes to 'confirm=true' but does not add new semantic meaning beyond what the schema already provides. Baseline 3 is appropriate.

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 title and description clearly state the action ('Ship') and resource ('a batch'), and the verb+resource combination distinguishes it from sibling tools like deftship_create_batch and deftship_get_batch. The description also specifies 'all valid items in a batch' for precise scope.

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 states the prerequisite: 'The batch must be in 'ready' status.' It also provides guidance on asynchronous behavior: 'Processing is asynchronous; poll deftship_get_batch for labels.' This helps the agent understand when to use and follow up. However, it does not explicitly mention when not to use the tool.

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