Create Quote

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

Annotations indicate readOnlyHint=false, destructiveHint=false, idempotentHint=false. The description adds context that the tool performs a creation-like action but is non-destructive and intended for comparison. It clarifies the side effect (creating a quote) and the scope of returned data, which is helpful beyond the sparse 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 concise with clear sections: action, purpose, parameter breakdown, return format, and examples. Every sentence adds value, and the structure makes it 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?

Despite no output schema, the description provides a sample return structure. It covers what the tool does, when to use it, what parameters are needed, and what results to expect. It is complete for its complexity and well-aligned with sibling context.

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 input schema has 100% coverage for the single parameter 'quote' with a brief description. The tool description elaborates on the structure of the quote object (companyId, addresses, items, optional filters) and includes a Returns section with example fields. This adds substantial meaning beyond the schema.

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 that the tool creates a freight quote and returns available carrier rates. It distinguishes from siblings by positioning this tool as a comparison step before consignment creation, and explicitly contrasts with machship_create_consignment in the 'Don't use' example.

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 provides explicit guidance: 'Use this to compare carrier prices and transit times before creating a consignment' and includes a specific 'Don't use when' scenario with an alternative tool (machship_create_consignment). This leaves no ambiguity about when to invoke this tool.

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