Get Consignments by Carrier Consignment ID

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

Annotations already indicate readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true. The description adds that it limits results to a max of 10, providing extra behavioral context. No contradictions.

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, using a single sentence for the purpose and a bullet for the argument. No redundant 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?

Given the simplicity of the tool (one parameter, no output schema), the description is largely complete. It covers the key constraint (max 10) and the nature of the IDs. It could mention what happens if IDs are not found, but this is a minor gap.

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 defines the parameter as an array of carrier consignment IDs with a max of 10, clarifying that these are 'carrier's own consignment/tracking ID'. This adds context beyond the schema's description, which only says 'Carrier consignment IDs (max 10)'.

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 it finds consignments by the carrier's own consignment/tracking ID. It specifies the resource and the lookup key, but does not explicitly differentiate from sibling tools like get_consignments_by_ids or search_consignments.

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 mentions a max limit of 10 per request, which is a constraint, but does not provide explicit guidance on when to use this tool versus alternatives (e.g., when you have a carrier ID vs. internal ID). Usage is implied by the tool name.

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