logistics_consignment_manifest

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

Without annotations, the description explains the high-level behavior: uploading BOM, comparing inventory, determining shipping needs, and warning to review. However, it does not specify whether the operation is read-only, if it modifies any data, or what side effects occur, leaving some behavioral ambiguity.

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 efficient with three sentences: purpose, process, and caution. It is front-loaded with the tool's main action and has no redundant information, making it easy for an agent to parse quickly.

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 existence of an output schema, the description need not detail return values. It covers the core workflow and a critical warning. Minor gaps include lack of error condition hints or prerequisites, but overall it is sufficiently complete for a well-defined tool.

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% description coverage, so each parameter is documented. The description rephrases the schema's meaning (e.g., 'diffing BOM vs inventory' maps to bom_path and inventory_levels) but adds only minimal new context beyond what the schema already provides.

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's function: 'Generate a consignment manifest by diffing BOM vs inventory.' It specifies the verb (generate) and resource (consignment manifest), and distinguishes from siblings like logistics_create_shipment by being a specific preparatory step.

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 identifies the tool as 'Station 4', implying its place in a workflow, and instructs to review the manifest before shipping. It provides context on when to use (after BOM and inventory are available) but does not explicitly exclude alternative scenarios or compare with other logistics tools.

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