Skip to main content
Glama

WooCommerce: Get sales report

woocommerce_get_sales_report
Read-only

Retrieve WooCommerce sales totals and date-range data for a specified site to analyze revenue over a chosen period.

Instructions

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

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "site": "<site>"
    },
    "name": "woocommerce_get_sales_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteYes
periodNoweek
date_maxNo
date_minNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0
  2. Removedv3.13.1
  3. First observedv3.4.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds that results include totals and date ranges and warns that the v3 API has limited reporting capabilities, which is useful context, but the caveat is vague and no auth, pagination, or result-shape details are provided.

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?

Three short sentences, front-loaded with the core purpose and no wasted filler. The '[UNIFIED]' tag is the only clearly unnecessary token.

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?

For a tool with no output schema and 0% parameter description coverage, the description leaves too much unspecified: it does not explain the period/date interaction, the response structure beyond 'totals and date ranges', or what 'limited reporting capabilities' concretely means. An agent could call it, but only by guessing at parameter semantics.

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?

Schema description coverage is 0%, so the description must compensate for four undocumented parameters. It only vaguely gestures at 'date ranges' and never explains the 'period' default ('week'), accepted period values, or the expected format/relationship of date_min and date_max.

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 report') and says it returns sales data with totals and date ranges. It does not distinguish itself from siblings such as woocommerce_get_top_sellers or woocommerce_get_customer_report, and the '[UNIFIED]' prefix is unexplained jargon.

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 guidance on when to use this report versus the sibling report tools, and no prerequisites or exclusions are given. The reader is left to infer that this is the general sales report rather than a specialized one.

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

Deploy Server

Other Tools