Create Consignment with Complex Items

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

Annotations already indicate this is a write operation (readOnlyHint=false) and not destructive. The description adds that it creates a consignment with complex items, which is consistent with annotations. No further behavioral details (e.g., permissions, side effects) are disclosed beyond the basic create action.

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—two sentences, one for purpose and one for parameter. It uses an 'Args:' label for clarity and contains no redundant information.

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 complexity of the consignment object (nested, with dangerous goods), the description is minimal. It does not explain required fields, structure of complexItems, or return format. The openWorldHint true further signals need for clarity that is absent.

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 coverage is 100% for the single parameter, so baseline is 3. The description merely repeats the schema description ('Consignment data with complexItems array'), adding no new meaning or constraints beyond what the schema 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 it creates consignments with complex item definitions, including detailed packaging and dangerous goods data. It distinguishes from siblings like machship_create_consignment by specifying the use of a complexItems array instead of standard 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?

The description implies usage when detailed packaging or dangerous goods are needed, but it does not explicitly contrast with alternatives like machship_create_consignment or machship_create_consignment_existing_items. No when-not-to-use guidance is provided.

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