Skip to main content
Glama

Sales Report

woo_sales_report
Read-only

Get WooCommerce sales summary for a given period. Returns total sales, net sales, total orders, total items sold, total shipping, total refunds, and total discount.

Input Schema

NameRequiredDescriptionDefault
periodNoReport period (default: month)
site_idNoSite ID to target (optional if you have only one connected site)
date_maxNoEnd date (YYYY-MM-DD) for custom range
date_minNoStart date (YYYY-MM-DD) for custom range

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds genuine value by enumerating the returned metrics, which matters because there is no output schema, but it says nothing about custom-range behavior or whether metrics are scoped to the site_id.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, zero filler, and the purpose sentence is front-loaded ahead of the return-value enumeration. Every clause carries information an agent can act on.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, enumerating the returned metrics is the right compensation, and the annotations carry the safety profile. The remaining gap is the unexplained interaction between the period enum and the custom date_min/date_max range, which the description never addresses.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all four parameters (period enum, site_id, date_min, date_max) are already documented in the schema. The description's phrase 'for a given period' adds no syntax or format detail beyond what the schema provides, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Get WooCommerce sales summary') plus the scoping dimension ('for a given period'), which is enough to tell it apart from the only other report sibling, woo_low_stock_report. It does not explicitly name or contrast with that sibling, so it falls short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance: nothing tells the agent when a sales summary is the right call versus woo_low_stock_report, nor how to choose between the period enum and a custom date_min/date_max range. The period default of 'month' is only disclosed in the schema, not the description.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources