report_warehouse_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 only states the purpose and a required parameter, without disclosing behavioral aspects such as whether the operation is read-only, what stock statuses are included (e.g., pending, active), or authentication requirements.

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 very concise with two sentences. It front-loads the key purpose and emphasizes the required parameter. While it is short, it could be slightly more informative without sacrificing conciseness.

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?

Although an output schema exists, the description lacks necessary context for correct invocation: no parameter details beyond warehouse_id, no usage guidelines, and no behavioral traits. With 5 parameters and low schema coverage, the description is insufficient.

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?

Only 20% of parameters have descriptions in the schema (include). The tool description adds only 'warehouse_id is REQUIRED', which is already in the schema's required array. It does not explain start_date, end_date, or sku_sku, leaving them ambiguous.

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 it reports current stock balance per warehouse/SKU. The name and brief text indicate the tool's purpose, but it does not differentiate from sibling report tools like report_inventories or sku_quantity_in_warehouse.

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 states that warehouse_id is required, but does not provide guidance on when to use this tool versus alternatives (e.g., list_inventories, sku_quantity_in_warehouse). No when-not-to-use or context for choosing between tools.

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