get_shipment

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

The description only states it is read-only. With no annotations provided, it fails to disclose additional behavioral traits such as return format, potential errors, or state dependencies.

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 extremely concise with two sentences and an endpoint reference. No unnecessary information.

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?

For a simple get tool with one parameter and no output schema, the description is minimally adequate. It identifies the resource and states read-only, but could be more complete about return values or error scenarios.

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 mentions 'by id' but adds no semantics beyond the input schema. The parameter name is self-explanatory, yet with 0% schema description coverage, the description should elaborate on what the shipment_id represents or its format.

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 clearly states the action 'Get', the resource 'shipment (physical forwarding batch)', and the identifier 'by id'. This distinguishes it from sibling tools like list_recipients or create_recipient.

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?

Usage is implied as a simple retrieval by ID, but no explicit guidance on when to use versus alternatives or when not to use. No exclusions or context provided.

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