Skip to main content
Glama

Frontman for WordPress

wc_get_coupons_report

Read-onlyIdempotent

Retrieves WooCommerce coupons reports. Mirrors woocommerce-mcp-server method get_coupons_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_coupons_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number. Default 1.
periodNoReport period. Default month.
dateMaxNoOptional maximum date.
dateMinNoOptional minimum date.
filtersNoWooCommerce REST API report filters to pass through.
perPageNoNumber of results per page. Default 10, max 100.
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

B3.2/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 behavior, so safety is covered. The description adds a genuinely useful deployment fact - local WordPress authentication with no REST API keys required - but says nothing about aggregation, pagination behavior, or what the report contains.

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, no padding. The reference to mirroring the upstream woocommerce-mcp-server method is mildly redundant for an agent, but the auth note in the same sentence earns its place.

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?

For a seven-parameter reporting tool with no output schema and a free-form pass-through filters object, the description should say what the report returns (coupon usage totals, per-coupon rows) and roughly how filters interact with dateMin/dateMax/period. The auth context partially compensates, but key behavioral detail is missing.

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%, including period, dateMin/dateMax, perPage limits, and the site_id prerequisite, so the schema carries all parameter meaning. The description adds nothing about parameters, which is acceptable at this coverage level but not a value-add.

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 coupons reports.' That implicitly separates it from the plain coupon-listing sibling wc_get_coupons and from other report tools, but the description never explicitly draws that distinction, so an agent must infer it.

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 wc_get_coupons or the other report endpoints, and no note on prerequisites such as calling list_sites first (that only appears in the schema). Usage is left entirely to inference from the name.

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.