Create shipment batch

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

Discloses asynchronous validation, beta status, and USPS-account restriction. Annotations indicate mutation but description adds concrete behavioral context beyond annotations.

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?

Two sentences, perfectly sized: first defines purpose, second explains async behavior and next steps. 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?

Covers the creation workflow and async validation. Missing what the tool returns (e.g., batch ID), but the schema and sibling names fill most gaps. Still leaves a small gap for the agent.

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 100%, so baseline is 3. Description does not add any parameter info beyond what the schema already provides.

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?

Description clearly states the verb 'Create', resource 'shipment batch', and key constraints: beta, own-USPS-account only, up to 1,000 shipments, sharing shipper and service. This distinguishes it from siblings like deftship_get_batch and deftship_ship_batch.

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?

Provides explicit workflow: poll deftship_get_batch until 'ready', then deftship_ship_batch. Clarifies that it does not spend money yet. Lacks explicit when-not-to-use but strongly implies the context.

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