Skip to main content
Glama

woocommerce_get_sales_report

Retrieve WooCommerce sales data with totals and date ranges to analyze store performance and track revenue trends.

Instructions

[UNIFIED] Get WooCommerce sales report. Returns sales data with totals and date ranges. Note: WooCommerce v3 API has limited reporting capabilities.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteYes
periodNoweek
date_minNo
date_maxNo
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions the return structure ('sales data with totals and date ranges') and API version limitations, but fails to disclose read-only status, authentication requirements, rate limits, or error handling behavior expected for a reporting tool.

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

Conciseness4/5

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

The description is appropriately concise at three sentences with the main purpose front-loaded. The '[UNIFIED]' prefix appears to be metadata leakage or internal tagging that doesn't add semantic value, but otherwise the structure efficiently conveys the core function and limitation note.

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

Completeness2/5

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

Given the tool has 4 parameters with 0% schema coverage, no output schema, and no annotations, the description is insufficient. It describes the return values generally but leaves all input parameter semantics undocumented and lacks critical behavioral context (auth, safety, pagination) that would be necessary for correct invocation.

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

Parameters2/5

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

With 0% schema description coverage, the description must compensate for undocumented parameters. It mentions 'date ranges' which loosely implies the date_min/date_max parameters, but provides no format guidance, does not explain the 'period' parameter (default: 'week'), and does not clarify what 'site' expects (URL, ID, etc.).

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?

The description clearly states the tool retrieves WooCommerce sales reports with specific mention of 'totals and date ranges' as output. It distinguishes from sibling tools like 'woocommerce_get_customer_report' (customer-focused) and 'woocommerce_get_top_sellers' (specific ranking view) by specifying general 'sales report' functionality.

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?

The description includes a note about WooCommerce v3 API limitations, which provides implicit guidance about capability constraints. However, it lacks explicit guidance on when to use this versus alternative reporting tools like 'woocommerce_get_top_sellers' or 'woocommerce_get_customer_report', and does not specify prerequisites or exclusion criteria.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/airano-ir/mcphub'

If you have feedback or need assistance with the MCP directory API, please join our Discord server