iqms_sales_orders_list

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

The description does not explicitly state that the tool is read-only or list any side effects. With no annotations provided, the description carries the full burden but only says 'List sales orders,' which implies read-only but leaves other behavioral traits (e.g., pagination via 'limit', sorting, authentication) unaddressed.

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 a single sentence of 11 words with no redundancy. It is front-loaded with the primary action and includes key filter information. Every word contributes directly to understanding.

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 no output schema and no annotations, the description lacks important details such as expected return format, pagination behavior (limit parameter), default sorting, or whether filters are inclusive. For a list tool with 5 parameters, more context is needed for effective use.

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 description mentions three filtering options (status, customer, requested ship date) that map to parameters, but it does not add meaning beyond the schema's basic info. Schema coverage is 40% (only ISO date descriptions), so the description partially compensates but could elaborate on parameter usage or format.

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 'List sales orders' and specifies the filtering options (status, customer, requested ship date), which directly matches the tool name and input schema. It distinguishes itself from sibling list tools (e.g., purchase orders, work orders) by the resource type.

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 is provided on when to use this tool versus alternatives like iqms_purchase_orders_list or iqms_workorders_list. There is no indication of context, prerequisites, or which scenarios are appropriate for this tool.

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