Get Consignment PDF File Info

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds 'without downloading', which reinforces non-destructive behavior. However, it lacks details on authentication requirements, rate limits, or potential side effects beyond what annotations cover.

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 two sentences long, front-loaded with the purpose, and includes a clear argument list. Every sentence earns its place without redundancy or unnecessary detail.

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?

For a metadata retrieval tool with no output schema, the description adequately lists the returned fields (name, size, URL). Combined with the informative annotations and simple parameter, no additional information is necessary for an agent to understand the tool's behavior.

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 describes consignmentId as 'Consignment ID' with type integer. The description restates the same information in Args without adding extra context (e.g., format, source, or validation rules). Since schema coverage is 100%, the description adds no additional meaning.

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 file metadata (name, size, URL) for the consignment label PDF without downloading it. This specific verb+resource combination effectively distinguishes it from sibling tools like 'machship_get_consignment_label_pdf'.

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 getting metadata instead of downloading, but does not explicitly state when to use this tool versus alternatives. No when-not-to-use or alternative names are provided, leaving the agent to infer context from the tool name alone.

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