Retrieve WooCommerce sales reports for a WordPress site by week, month, last month, year, or custom date range.
Get sales report
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Site id (see list_sites) | |
| period | No | month | |
| date_max | No | End date (YYYY-MM-DD) | |
| date_min | No | Start date (YYYY-MM-DD) |
Changes observed during successful MCP inspections.
v3.4.0Input schema / properties / siteAdded value: +{
+ "description": "Site id (see list_sites)",
+ "type": "string"
+}Input schema / requiredAdded value: +[
+ "site"
+]v2.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden and delivers almost nothing. 'Get' weakly implies a read-only operation, but there is no mention of required site context, how period/date filters interact, pagination, or what the report returns.
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?
Three words is not conciseness here but under-specification; the sentence is front-loaded but carries no substantive information an agent could act on.
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 annotations and no output schema, the description is far too thin: it omits report contents, filtering semantics, and what results to expect, so an agent cannot confidently select or call it.
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 75% and the description adds zero parameter meaning on top of it. In particular the 'period' enum and the date_min/date_max interaction are left entirely to the schema, and the description does not compensate for the undocumented field.
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?
States a verb ('Get') and a resource ('sales report'), so the basic operation is identifiable. However, it does not specify what the report contains or how it differs from closely related siblings like woo_stock_report and woo_top_sellers, leaving the scope vague.
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 versus the other WooCommerce reporting tools (woo_stock_report, woo_top_sellers, woo_list_orders). The agent must guess which report tool answers a given sales question.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.