get_total_stock

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

No annotations are provided, so the description carries the full burden. It does disclose the read-only nature ('Retrieve') and the four quantity categories returned, but it omits operational traits such as result-set size when topN is omitted (returning ALL items), pagination, data freshness, or whether values are aggregated across warehouses. These gaps are mitigated by the tool being a simple, clearly read-oriented list operation.

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?

A single, efficient sentence front-loads the verb and resource, then compactly enumerates the output categories. Every element earns its place and nothing repeats the schema's parameter documentation.

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?

This is a simple filtered-list tool with all parameters fully documented in the schema, so the baseline burden is modest. However, with no annotations and no output schema, the description should clarify the return format and the scale implication of omitting topN ('return ALL items' per the schema hint), as well as warehouse aggregation semantics. Adequate, but with identifiable gaps.

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 description coverage is 100% — all three parameters (topN, search, inStockOnly) are already documented in the schema, so the baseline of 3 applies. The tool description adds no parameter-level meaning; the useful 'recommended' hint on topN lives in the schema, not the description.

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 uses a specific verb ('Retrieve') with a clear resource ('total stock levels for all inventory items in SAP B1') and enumerates the returned quantity categories (on-stock, committed, on-order, available). The 'all inventory items' scope distinguishes it from item-specific siblings like check_atp, though it does not explicitly name any alternative.

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 given on when to use this tool versus siblings such as check_atp, monitor_reorder_items, or get_open_orders. There are no exclusions, prerequisites, or selection criteria stated — usage context is only weakly implied by the described purpose.

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