ship_items_by_line

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

With no annotations provided, the description carries the full disclosure burden. It usefully discloses failure behavior (purchaseorder throws unsupported) and the API version constraint, but says nothing about side effects — whether stock is decremented, whether the document status transitions, whether partial/repeat shipments are allowed, or what permissions are required.

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?

Three short sentences, no filler, and the supported-docType constraint is front-loaded ahead of the failure mode. Every sentence earns its place by preventing a distinct class of wrong call.

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?

Without an output schema or annotations, the description should say more about what happens on success and what the lines structure means (units vs. full-line shipment). It is complete on docType validity but incomplete on outcome and partial-shipment semantics.

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%, so the baseline is 3, but the description adds real meaning the schema cannot: the docType enum lists eleven values while only salesorder actually works. That rescues the agent from a schema that would otherwise invite an invalid call.

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?

States a specific verb+resource ('Ship specific items by line') and pins the exact endpoint and supported document type. Implicitly distinguishes itself from ship_all_items via 'by line', but never names that sibling, so the differentiation is inferential rather than explicit.

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?

Gives unambiguous when-not-to-use guidance: purchaseorder line-level receive is unverified and throws unsupported, and all other docTypes are unsupported — an agent can rule out every enum value except salesorder. It does not name ship_all_items as the alternative for whole-order shipping, leaving the routing choice to inference.

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