getInventory

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 specifies the operation (get total stock levels) and scope (all parts) but does not disclose whether the operation is read-only, whether it returns an aggregate count or detailed per-part data, or any other behavioral traits like permissions or response format.

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, concise sentence that immediately conveys the tool's purpose. It contains no filler, and every word contributes to the meaning. The structure is optimal for a tool with no parameters.

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 the tool's simplicity (no parameters, no output schema, no annotations), the description is largely complete. It clearly states the action and scope. However, it could briefly mention that the result is an aggregate stock-level view to avoid ambiguity, since sibling tools like getLowStockItems exist.

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 tool has zero parameters, so the baseline is 4. The description adds contextual meaning by specifying 'all parts,' which reinforces that no filters are needed. No additional parameter semantics are required.

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 and resource: 'Get total inventory stock levels for all parts.' It clearly distinguishes from sibling tools like getLowStockItems, which focuses on filtered low-stock items, and forecastInventory, which predicts future stock. The scope ('all parts') adds clarity.

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 implies usage when an agent needs a broad inventory overview, but it does not explicitly state when not to use it or mention alternatives like getLowStockItems for low-stock queries. The context is clear but lacks explicit exclusions or alternative guidance.

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