Skip to main content
Glama

woocommerce-mcp

A small, read-only Model Context Protocol server for WordPress + WooCommerce. It lets Claude (or any MCP client) answer questions about a live store — products, orders, sales, and blog posts — over the official REST APIs. No writes, no plugins to install on the store: it talks to the existing WordPress/WooCommerce REST endpoints.

Built and maintained by WPPoland, a senior WordPress developer working with WordPress since 2006. If you need this wired into a real store stack, we build WooCommerce ERP and API integrations and enterprise e-commerce architecture (headless, integrations, AI-ready data).

Tools

Tool

What it does

Needs WooCommerce keys

list_products

List / search products (name, sku, price, stock, permalink)

yes

get_product

Full details for one product by id

yes

list_orders

Recent orders, newest first, optional status filter

yes

sales_report

Sales totals for a period (week / month / last_month / year)

yes

search_posts

Search published blog posts (public WP REST API)

no

Everything is read-only. The server never creates, edits, or deletes anything in the store.

Related MCP server: WooCommerce MCP Server by CData

Install & build

From npm (package name is scoped - the unscoped woocommerce-mcp name is locked on the registry):

npm install -g @wppoland/woocommerce-mcp
# or: npx @wppoland/woocommerce-mcp

From source:

git clone https://github.com/wppoland/woocommerce-mcp.git
cd woocommerce-mcp
npm install
npm run build

Configure

Set three environment variables:

Var

Required

Example

WP_URL

yes

https://shop.example.com

WC_CONSUMER_KEY

for wc_* tools

ck_xxx

WC_CONSUMER_SECRET

for wc_* tools

cs_xxx

Create the WooCommerce keys in WooCommerce → Settings → Advanced → REST API → Add key with Read permission. search_posts works without keys against any public WordPress site.

The keys are sent to your own store over HTTPS as REST query auth. Use HTTPS, and give the key Read access only.

Use with Claude Desktop / Claude Code

Add to your MCP client config (e.g. claude_desktop_config.json):

{
  "mcpServers": {
    "woocommerce": {
      "command": "node",
      "args": ["/absolute/path/to/woocommerce-mcp/dist/index.js"],
      "env": {
        "WP_URL": "https://shop.example.com",
        "WC_CONSUMER_KEY": "ck_xxx",
        "WC_CONSUMER_SECRET": "cs_xxx"
      }
    }
  }
}

Then ask things like "What were last month's WooCommerce sales?" or "List the 5 most recent orders that are on hold."

Docs on wppoland.com

Articles (off-site)

Field notes published on DEV (not duplicates of wppoland.com pages):

Show HN: discussion

Verify

npm run check   # builds, then asserts all five tools register (no network/credentials needed)

Notes

  • Node 18+ (uses the built-in fetch).

  • Logs go to stderr so they never corrupt the stdio MCP protocol on stdout.

  • API errors are surfaced with the store's message; credentials are never echoed.

License

MIT © WPPoland

Available Tools

2 tools
sales_reportSales reportA

WooCommerce sales totals for a period (week, month, last_month, year). Gross sales, orders, items.

ParametersJSON Schema
NameRequiredDescriptionDefault
periodNoReporting period (default week)

TDQS

A4.1/5.0
Behavior4/5

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

No annotations are provided, so the description carries the burden. It discloses the return metrics (gross sales, orders, items) and period options. However, it does not mention read-only status, response format, or potential errors, though the simple nature reduces need.

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?

Extremely concise: one sentence front-loaded with key details (platform, purpose, periods, metrics). No unnecessary words.

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 single-parameter tool with no output schema, the description covers the essential: what it does, what periods are available, and what data is returned. No gaps.

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 period parameter fully described. The description restates the enum values but adds no additional meaning beyond the schema. Baseline 3 is appropriate as description does not improve understanding.

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 it returns WooCommerce sales totals for a period, listing specific metrics (gross sales, orders, items) and periods. It explicitly distinguishes from sibling tools like get_product and list_orders, which focus on individual items or order lists.

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?

The description implies use when sales aggregations are needed but does not specify when to avoid it or contrast with alternatives (e.g., list_orders for detailed view). No explicit guidance on context or prerequisites.

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

search_postsSearch postsA

Search published WordPress blog posts (public REST API, no WooCommerce keys required).

ParametersJSON Schema
NameRequiredDescriptionDefault
searchYesSearch term
per_pageNoResults per page (default 10)

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations provided, the description must carry the full burden of behavioral disclosure. It does disclose that the API is public and that no WooCommerce keys are needed, which is useful. However, it does not mention other behavioral traits such as rate limits, pagination behavior, or what happens if no results are found. The transparency is adequate but minimal.

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 a single sentence of 13 words, extremely concise. It front-loads the key information: what the tool does and a critical constraint (no WooCommerce keys). No unnecessary words are present, making it highly efficient.

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?

Given the low complexity (2 parameters, no output schema, no enums, no nested objects), the description is minimal but partially complete. It covers the core functionality and a key context point (public API, no keys). However, it does not describe the return format or any output behavior, which would be helpful given the lack of output schema. For a simple tool, it is adequate but could be more complete.

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?

The input schema already has 100% coverage, describing the 'search' and 'per_page' parameters. The description does not add any additional meaning to these parameters beyond what is in the schema. Therefore, the description adds no extra value to parameter understanding, resulting in a baseline score 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 the verb 'Search' and the resource 'published WordPress blog posts'. It also specifies that this is a public REST API with no WooCommerce keys required, which distinguishes it from the sibling tool 'sales_report' that may require such keys. The purpose is specific and unambiguous.

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?

The description provides some context about when to use this tool (public search without WooCommerce keys) but does not explicitly state when not to use it or mention alternatives. It implies that if WooCommerce keys are needed, another tool like 'sales_report' should be used, but this is not directly stated. Usage guidance is present but incomplete.

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

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 1 tool updatev0.1.1
    • Addedsearch_posts
  2. 4 tool updates
    • Removedget_product
    • Removedlist_orders
    • Removedlist_products
    • Removedsearch_posts
  3. 5 tool updatesv0.1.0
    • First observedget_product
    • First observedlist_orders
    • First observedlist_products
    • First observedsales_report
    • First observedsearch_posts

TDQS

B3.4/5.0

Scored across 2 tools

Disambiguation5/5

The two tools serve entirely different purposes: one provides WooCommerce sales reports, the other searches WordPress blog posts. There is zero overlap in functionality, making it impossible to confuse them.

Naming Consistency2/5

Tool names use different patterns: 'sales_report' is a noun phrase, while 'search_posts' follows a verb_noun pattern. This inconsistency makes the set feel ad hoc rather than systematically named.

Tool Count2/5

With only 2 tools for a 'woocommerce-mcp' server, the count is far too low. While a minimal server could be justified, the expected scope for WooCommerce typically includes many more operations (e.g., products, orders, customers).

Completeness1/5

The tool surface is severely incomplete for WooCommerce. Key operations like managing products, orders, or customers are entirely missing, and the inclusion of a general WordPress search tool unrelated to e-commerce does not address the core domain.

Maintenance

ActivityActive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers