Create Shipment Order

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

Annotations already indicate readOnlyHint=false and openWorldHint=true. The description adds value by listing required fields, explaining the additional_fields mechanism, and stating the return value ('new order identifier / status'). This goes beyond the annotations without contradicting them.

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 three sentences, front-loaded with the primary action, and each sentence adds critical information (required fields, lookup resolution, return type). No filler or redundancy.

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 15-parameter tool with nested objects and no output schema, the description covers required fields, additional_fields, and return value. It does not address error cases or duplicate-code behavior, but given schema richness and openWorldHint, this is adequate.

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 80%, so the baseline is 3. The description adds meaningful guidance by instructing to resolve type/warehouse/currency values via logiwa_lookup, which is not in the schema. It also clarifies that customer/shipmentAddress/billingAddress should be objects matching the Logiwa API, reinforcing schema descriptions.

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 opens with 'Create a new shipment (outbound) order,' which uses a specific verb and resource. It clearly distinguishes from sibling tools like logiwa_create_purchase_order and logiwa_create_return_order by naming the order type (shipment/outbound).

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 provides clear context for when to use this tool (creating a shipment order) and includes actionable guidance such as 'Resolve type/warehouse/currency values with logiwa_lookup' and 'Any other fields go in additional_fields.' However, it does not explicitly mention when not to use it or compare with alternatives.

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