Get Consignment by Pending Consignment ID

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

Annotations (readOnlyHint=true, idempotentHint=true) indicate a safe read operation. The description adds behavioral insight by noting that the consignment details are retrieved 'if it exists', implying possible null result. This adds value 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?

The description is short and front-loaded with the purpose. However, the Args section is redundant given the schema, which slightly reduces conciseness. Still efficient overall.

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 tool's simplicity (one parameter, no output schema), the description covers the essential information: what it does, the condition (if exists), and the parameter. No further details are needed for a complete understanding.

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 coverage is 100% (the only parameter 'id' is fully described in the schema). The description's Args section merely repeats the schema information without adding new meaning, so no additional value for semantics.

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 'Get consignment details' using a specific resource (pending consignment ID that has been transformed into a consignment). It distinguishes from sibling tools like machship_get_consignment (which uses a consignment ID) and machship_get_pending_consignment (which gets pending consignment).

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 explains that the tool is for getting consignment details from a pending consignment ID that has been linked, but it does not explicitly state when to use this tool over alternatives (e.g., machship_get_consignment_by_ids or machship_get_pending_consignment). Usage context is implied but not explicit.

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