Get Available Routes (Batch)

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description's simple statement 'Returns available routes' is consistent but adds little beyond that. It does not disclose any additional behavioral traits like result limits or performance characteristics.

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 plus an Args section. It front-loads the core purpose and then immediately details the parameter. No unnecessary words.

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?

While the parameter is well-described and annotations cover safety, the description lacks any information about the return value format (e.g., an array of routes). Given the tool's simplicity and the presence of a single route sibling, this is a minor gap but acceptable.

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 adds significant meaning beyond the schema by stating that the 'requests' array contains 'route request objects (same structure as single route request)', linking to an established structure and clarifying the parameter's composition. With 100% schema coverage, this is highly informative.

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 returns available routes for multiple shipment requests, using a specific verb ('Returns') and resource ('routes'). It distinguishes from siblings by explicitly mentioning 'batch' and 'bulk rate shopping', contrasting with the single route tool (machship_get_routes).

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 implies usage for bulk rate shopping across multiple shipments, providing clear context. However, it does not explicitly state when not to use or name alternatives, though the sibling tool name (machship_get_routes) is implicit.

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