clm_get_shipment

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered. The description adds valuable behavioral context by revealing that the record may have up to 142 fields, most of which are typically absent, preparing the agent for sparse or large responses.

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, no filler, with the core action and scope front-loaded. The sibling alternative is included in a compact second sentence, making the description both efficient and informative.

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 one-parameter read operation with full schema coverage, read-only annotations, an output schema, and an explicit alternative, the description covers everything an agent needs to invoke and interpret the tool correctly. No critical context is missing.

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% and the single required parameter is already documented as 'The shipment's id.' The description reinforces lookup 'by id' but does not add extra format, source, or domain nuance beyond what the schema provides, which is acceptable given full coverage.

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 uses a specific verb ('Retrieve') and resource ('full internal shipment record by id'), and clearly distinguishes itself from the sibling clm_get_shipment_summary by calling itself 'full internal' versus 'smaller, external-facing'. An agent can immediately tell what this tool returns and how it differs from the nearest alternative.

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 instructs the agent to prefer clm_get_shipment_summary for a smaller, external-facing view, which provides a clear selection rule between siblings. This is direct when-to-use guidance rather than leaving the choice implicit.

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