Get Available Routes

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

Annotations indicate readOnlyHint=true, destructiveHint=false. The description adds context by stating the return includes 'rates, ETAs' and mentions the single shipment scope. While it doesn't detail every behavioral trait, it complements the annotation well without contradiction.

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 concise, uses a clear 'Args:' section, and front-loads the core purpose. Every sentence adds value, and the structure is easy to parse.

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?

No output schema exists, so the description should describe the return value. It mentions 'list of available freight routes and carrier services (rates, ETAs)' which gives a basic understanding, but could be more detailed about the structure of each route object. Overall, adequate given the tool's complexity.

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 breaks down the 'request' object beyond the schema's brief description, listing explicit fields like companyId, fromSuburb, items with weight/dimensions, and optional despatchDate. This adds significant meaning for the agent.

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 'Returns a list of available freight routes and carrier services for a single shipment request' and the title 'Get Available Routes' directly conveys the purpose. It distinguishes itself from siblings like machship_get_routes_batch and machship_get_routes_complex_items by specifying 'single shipment request'.

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 explicitly says 'Use this to find all carrier options (rates, ETAs) before creating a consignment', providing clear guidance on when to use the tool. It does not explicitly state when not to use it or mention alternatives, but it sufficiently orients the agent.

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