Skip to main content
Glama

List coupons

wp_wc_list_coupons
Read-onlyIdempotent

List published WooCommerce coupons with ID, code, amount, discount type and expiry date, newest first in a single read-only page for auditing or managing promotions.

Instructions

WooCommerce: list the shop's published coupons with id, code, amount, discount_type and expires (YYYY-MM-DD or null). One page only, newest first; there is no paging. Read-only; needs manage_woocommerce. Requires WooCommerce.

Input Schema

NameRequiredDescriptionDefault
per_pageNoHow many coupons, 1 to 200. Default 50.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv4.7.0

TDQS

A4.3/5.0
Behavior5/5

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

Beyond annotations already declaring read-only/idempotent behavior, the description adds meaningful operational detail: only published coupons are returned, results are newest first, there is no paging, required fields are identified, and both WooCommerce and manage_woocommerce prerequisites are disclosed.

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

Conciseness5/5

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

The description is compact and front-loaded: it identifies the resource, returned fields, paging limitation, safety profile, and permissions in only a few dense clauses. No sentence is wasted.

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

Completeness5/5

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

For a simple one-parameter list tool with no output schema, the description supplies enough context to call it correctly: return fields, ordering, paging behavior, and authorization requirements. Nothing materially important appears 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% and the single per_page parameter is fully documented in the schema. The description adds no extra per_page semantics, so this is a baseline 3 case where the schema carries the parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('list the shop's published coupons') and names the returned fields, so an agent can distinguish it from order/product/customer list siblings without opening the schema.

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?

Usage is implied by the purpose statement and prerequisites ('Requires WooCommerce', 'needs manage_woocommerce'), but there is no explicit when-to-use guidance or comparison against alternatives. The limitation 'One page only; there is no paging' is useful context but is not framed as an alternative-selection rule.

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