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

mcp-server-woocommerce

by AmitGurbani
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_coupon

Read-only

Retrieve full WooCommerce coupon details including usage limits, product restrictions, and expiry date. Optionally request only specific fields.

Instructions

Get full coupon details including usage limits, product restrictions, and expiry date. Use fields param to request only needed fields.

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": {
      "id": "<id>"
    },
    "name": "get_coupon"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesCoupon ID
fieldsNoComma-separated fields to return (default: id,code,discount_type,amount,usage_count,date_expires,individual_use,product_ids,excluded_product_ids,usage_limit,usage_limit_per_user,minimum_amount,maximum_amount,free_shipping)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is known. The description adds value by specifying the kind of details returned (usage limits, restrictions, expiry) and that the fields param can filter output, going beyond the annotations.

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?

Two concise sentences, front-loaded with the core purpose and then a helpful usage tip. No wasted words.

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

Completeness4/5

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

The tool is simple with two params and no output schema. The description covers the essential behavior and return content, and the schema provides the rest. It is complete enough for an agent to invoke correctly.

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 coverage is 100%, with both id and fields described in the schema. The description's mention of the fields param adds no new semantic detail beyond the schema, so baseline 3 is appropriate.

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 the tool 'Get full coupon details' with specific resources mentioned: usage limits, product restrictions, and expiry date. This distinguishes it from sibling tools like list_coupons, which lists coupons, and other get_* tools for different resources.

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 implies this tool is for retrieving a single coupon's full details, contrasting with list_coupons for listings. It provides clear context on using the fields param to limit response size, but does not explicitly mention alternatives or when-not-to-use.

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