get_shipment

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

With no annotations, the description carries the full burden; it discloses the returned data shape (status, substatus, tracking, dates, address, items, logistic type) and the enumerated status values, which is strong for a read tool. It does not state read-only semantics explicitly or any auth/permission requirements, but 'Get' and the read-oriented field list make the behavior clear.

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?

Front-loads the returned fields, then id provenance, status values, and the sibling pointer. Every clause carries information, though the status enumeration and provenance note make it slightly long relative to a single-parameter getter.

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?

No output schema exists, so the description appropriately enumerates return fields and status values to compensate. It stops short of describing error or not-found behavior, but is sufficient for correct invocation.

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 the schema already documents that shipment_id is a numeric id from order.shipping.id. The description's statement about id provenance largely duplicates that schema text, adding little beyond the baseline.

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+resource ('Get the shipping details of a sale') and enumerates the returned fields, so the agent knows exactly what it produces. It distinguishes itself from siblings by routing to get_orders for id discovery and get_shipment_label for labels.

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?

Explicitly states the prerequisite for obtaining shipment_id ('call get_orders first to find the shipment id') and names the alternative tool for a different task ('Use get_shipment_label to download the printable label'). When-to-use and alternative routing are both covered.

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