Skip to main content
Glama

Frontman for WordPress

wc_get_sales_report

Read-onlyIdempotent

Retrieves WooCommerce sales reports. Mirrors woocommerce-mcp-server method get_sales_report using local WordPress authentication; no WooCommerce REST API keys are required.

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_id": "<site_id>"
    },
    "name": "wc_get_sales_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
periodNoReport period. Default month.
dateMaxNoOptional maximum date.
dateMinNoOptional minimum date.
filtersNoWooCommerce REST API report filters to pass through.
site_idYesThe connected site's id returned by list_sites. Call list_sites first; do not use a URL or WordPress post ID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so safety is covered. The description adds real behavioral context with the local WordPress authentication and no-REST-keys requirement, which affects setup. It omits aggregation semantics, pagination, and what happens when period and date ranges combine.

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?

Two short sentences, front-loaded with the purpose followed by the auth clarification. Nothing is wasted, though the second sentence is more about server provenance than call-time behavior.

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

Completeness3/5

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

Adequate for a read-only report tool with full schema coverage, but the description gives no guidance on valid keys for the open-ended filters object (additionalProperties: true). It also omits the list_sites prerequisite that only appears in the schema.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description earns an extra point by clarifying that filters are pass-through WooCommerce REST API report filters, signaling a remote API contract. It adds no detail on period values (no enums defined) or date syntax beyond what the schema already says.

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: "Retrieves WooCommerce sales reports." It also distinguishes itself from siblings via the implementation detail (local WordPress auth, no REST API keys), though it doesn't explicitly contrast with the other report tools like wc_get_orders_report or wc_get_products_report.

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

Usage Guidelines3/5

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

No explicit when-to-use or when-not guidance; the only routing signal is the auth note. The list_sites prerequisite lives in the schema's site_id description, not the description itself, so usage is implied by the resource name rather than stated.

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.