Skip to main content
Glama
Sign In
mcp-server-woocommerce

mcp-server-woocommerce

by AmitGurbani
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

list_coupons

Read-only

Retrieve discount coupons with code, type, amount, and usage stats. Specify fields to limit response data.

Instructions

List discount coupons. Shows code, type (percent/fixed_cart/fixed_product), amount, and usage stats. Use fields param to request only needed fields.

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": "list_coupons"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number
fieldsNoComma-separated fields to return (default: id,code,discount_type,amount,usage_count,date_expires)
searchNoSearch term
per_pageNoItems per page (max 100)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.0

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already set readOnlyHint=true, so the read-only nature is disclosed. The description adds that it shows specific fields and usage stats, but no additional behavioral traits (e.g., pagination behavior, rate limits) are mentioned. With annotations covering the safety profile, this is adequate but not enhanced.

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 two concise sentences, front-loaded with the primary action. It includes essential return fields and a helpful hint about the fields parameter without any filler or redundant information.

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 read-only list tool with 4 optional parameters covered in the schema and no output schema, the description is complete. It explains what the tool does, what data is returned, and how to tailor the response. There are no missing critical details given the tool's simplicity.

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% for all 4 parameters (page, fields, search, per_page). The description only mentions the 'fields' parameter, which is already fully described in the schema. Therefore, the description adds little semantic value beyond the schema, matching the baseline of 3.

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 clearly states 'List discount coupons' with a specific verb and resource. It distinguishes itself from sibling tools like get_coupon, create_coupon, and delete_coupon by focusing on listing. It also specifies the key fields returned (code, type, amount, usage stats), making the purpose unambiguous.

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

Usage Guidelines4/5

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

The description makes it clear this is for listing coupons, which is the appropriate use case versus get_coupon for a single coupon. It provides usage advice for the 'fields' parameter ('request only needed fields'). However, it does not explicitly mention alternatives or when not to use this tool, though the sibling list provides context.

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