List Shipment Orders

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

The description discloses pagination behavior and return structure ('Returns: paginated { items[] } where each item includes the order identifier (UUID), code, status, warehouse, customer and dates.'). This adds value beyond the annotations, which already declare read-only and idempotent hints. It does not contradict annotations.

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 well-structured and front-loaded with the core purpose. It then concisely lists parameters and return format in a clear, scannable layout. Every sentence earns its place without unnecessary verbosity.

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 simple list tool with full schema coverage and informative annotations, the description is complete. It explains pagination, parameter defaults, and return fields. The lack of an output schema is mitigated by the detailed return description. No critical information is missing.

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 covers 100% of parameters with detailed descriptions, including defaults and constraints. The description restates the parameters but adds no additional semantics beyond what the schema already provides. Baseline of 3 is appropriate.

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: 'List shipment (outbound / sales) orders, paginated.' The verb 'list' plus the specific resource 'shipment orders' with the qualifier '(outbound / sales)' distinguishes it from sibling list tools like logiwa_list_purchase_orders and logiwa_list_return_orders.

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 by specifying that these are outbound/sales orders, which helps differentiate from purchase and return orders. However, it does not explicitly state exclusions or alternative tools, though the parenthetical qualifier gives sufficient context for the agent to choose this tool over related list tools.

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