iqms_inventory_onhand

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

Description notes the default hiding of zero-quantity rows, but with no annotations provided, it fails to disclose other behaviors like pagination, read-only nature, response format, or limits. Minimal behavioral context beyond the single default.

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?

Two sentences, no unnecessary words, front-loaded with primary action and key default behavior. Efficient and clear.

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, 5 parameters, and no annotations, the description is adequate but incomplete: it omits limits, no-parameter behavior, potential error conditions, and explicit statement that it's a read operation. Slightly below average completeness.

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 low (20%), but description adds value by implying parameters 'item', 'location', and 'lot' are filter keys. However, it does not explain 'limit' or confirm the default for 'hide_zero_on_hand' beyond schema. Partial compensation.

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?

Description clearly states the verb 'List' and resource 'on-hand inventory', with filtering by item, location, or lot. It distinguishes from sibling tools like iqms_inventory_adjust and iqms_inventory_lot_trace.

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 on when to use this tool vs alternatives, such as iqms_inventory_lot_trace for lot-level tracing or iqms_inventory_adjust for modifications. The description lacks context for selection.

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