Update Transport

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

Discloses that update is applied asynchronously and returns a process status, complementing annotations (idempotentHint=true, destructiveHint=false). No contradictions with 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?

Two sentences, no redundancy. First sentence states purpose, second provides parameter guidance and async behavior. Highly efficient and front-loaded.

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?

Lacks output schema but describes return type (process status) and references get_process_status for completion. Adequate for a simple update tool with good annotations.

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% with descriptions. Description adds context by specifying which parameters are required (trackAndTrace) and optional (transporterCode), and explains overall purpose.

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?

Clearly states it updates transport/tracking information for a shipment. Specific verb 'update' and resource 'transport/tracking information' with clear scope. Differentiates from sibling tools like update_offer or update_replenishment.

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?

Tells agent to provide track and trace code and optionally transporter code. Also mentions async behavior and suggests using get_process_status to check completion. No explicit exclusions but clear usage context.

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