Create Consignment

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

Annotations already indicate this is a write operation (readOnlyHint=false) and non-destructive. The description adds that the consignment is unmanifested, but does not disclose side effects, auth requirements, or other behavioral traits beyond what annotations imply.

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?

Two sentences with a bullet list of args. Front-loaded with purpose. No redundant information, but could be more structured with required vs optional fields.

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?

Lacks information on return values (no output schema) and error conditions. For a core booking operation, agents need to know what is returned upon success or failure. Does not mention idempotency or state changes beyond creation.

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?

While schema coverage is 100%, the description adds value by listing expected sub-fields (toAddress components, items structure, references) that are not in the schema description. This helps agents understand typical consignment structure, though optionality is not specified.

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 it creates a new unmanifested consignment and is the core operation for booking freight. It specifies the verb and resource, but does not explicitly differentiate from sibling creation tools like create_pending_consignment or create_consignment_existing_items.

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 on when to use this tool versus alternatives such as create_pending_consignment or create_consignment_with_complex_items. Lacks prerequisites, exclusions, or typical use cases.

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