woo_stock_report

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

No annotations exist, so the description must carry the full behavioral burden, and it does not. It never states that the operation is read-only, whether results are paginated, what the default status filter is, or what shape the report takes.

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?

It is a single four-word fragment with no wasted words, but the shortness reflects under-specification rather than tight writing. There is no front-loaded scope, filter, or return-value framing to anchor the call.

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?

For a reporting tool with no output schema, no annotations, and two of three parameters undocumented, the description supplies almost none of the missing context. An agent cannot tell what filters do or what the report returns.

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 only 33% (only 'site' is documented, and even that just points at list_sites). The description adds nothing about 'status' (lowstock/outofstock/onbackorder), the default lowstock filter, or 'limit' at 20, leaving the agent to rely entirely on the enum and defaults.

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 names a verb ('Get') and a resource ('stock status report'), so the general intent is legible. However, it does not distinguish this tool from nearby siblings such as woo_sales_report or woo_top_sellers, nor does it say what the report contains (low stock counts, per-product rows, thresholds).

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?

There is no guidance on when to use this report versus woo_bulk_update_stock or the sales/top-seller reports, and no prerequisites stated. An agent must infer usage purely from the name and the enum in the schema.

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