Get All Consignments

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, reducing the burden on the description. However, the description does not elaborate on pagination behavior, default filtering, or time zone implications. It adds some context via parameter names but lacks deeper behavioral disclosure.

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 very concise: one sentence summarizing the function, followed by a structured argument list. Every element is relevant, and the format is easily scannable.

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 complexity (9 parameters, no output schema, many siblings), the description is adequate but not complete. It explains the basic purpose and filtering options but omits details like response structure, pagination defaults, and the behavior of the filterByEtaCompletedOrDespatch parameter.

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 description coverage is low (33%), but the description compensates by listing all parameters with brief explanations. While not exhaustive (e.g., no enum values for filterByEtaCompletedOrDespatch), it provides meaningful descriptions for each parameter, especially those missing from 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 the tool returns all consignments for a company with filtering capabilities. It uses a specific verb ('Returns') and resource ('all consignments'), and the 'all' distinguishes it from siblings like get_active_consignments or get_completed_consignments.

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?

No guidance is provided on when to use this tool versus alternatives. The description does not mention scenarios where other getter tools (e.g., get_active_consignments) would be more appropriate, nor does it provide exclusion criteria.

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