Get Consignments by IDs (Batch)

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is clear. The description adds the batch size limit (max 100) but does not disclose details about return format, error handling, or authentication requirements. The statement 'Returns details' is vague.

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, consisting of two short sentences with no fluff. The key information (purpose and parameter) is front-loaded. Every word contributes value.

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 simplicity (one parameter, no output schema, no nested objects) and the strong annotations, the description provides sufficient context for a basic read operation. It could mention that the output matches individual consignment details, but the current level is adequate for agent understanding.

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 (the 'ids' parameter is fully described in the schema as an array of integers with min/max). The description merely restates the schema comment, adding no new semantic information about the parameter beyond what is already in 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 details for multiple consignments by their IDs, distinguishing it from sibling tools like 'get_consignment' (single) and other batch retrieval tools by specifying the use of consignment IDs directly. The max limit of 100 further clarifies scope.

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 when a list of consignment IDs is available, but it lacks explicit guidance on when to use this versus alternatives like 'get_consignments_by_carrier_id' or 'search_consignments'. No when-not-to-use or alternative recommendations are provided.

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