Skip to main content
Glama

wc_sales_report

Retrieve WooCommerce sales totals for a selected period—week, month, last month, or year—to track revenue and report performance.

Instructions

Sales totals for a period. Uses WooCommerce's reports endpoint.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "wc_sales_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
periodNomonth

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full burden. It implies a read-only aggregate but never states permissions required, whether data is cached/stale, or what the response contains — and there is no output schema to compensate.

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, front-loaded sentences with no filler. The brevity is appropriate in form, though it leaves substantive gaps that other dimensions penalize.

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 reporting tool with no annotations and no output schema, an agent still doesn't know what 'totals' means (revenue, order count, items sold) or the return shape. The definition is under-specified relative to the tool's purpose.

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%; the only parameter is an enum (week/month/last_month/year) with a default of month. The description says 'for a period' but adds no meaning about whether the period is relative to now, calendar-aligned, or how the default behaves.

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 resource (sales totals) and scope (a period), and notes the WooCommerce reports endpoint as the source. It is clear enough to distinguish from the sibling CRUD tools (products, orders, posts) but doesn't explicitly say so.

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?

No when-to-use guidance, no prerequisites, no mention of alternatives or exclusions. The only hint is 'Uses WooCommerce's reports endpoint', which describes implementation, not selection criteria.

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