mcp-woocommerce
面向 WooCommerce REST API 的生产级 MCP 服务——提供 73 个工具,涵盖产品、变体、属性、订单、客户、优惠券、评价、报告、配送、支付、Webhook、批量操作、库存和系统管理。
为什么要开发它
WooCommerce 为 36% 的电子商务业务提供支持(活跃商店超过 500 万家),但没有全面的 MCP 服务。此项目填补了这一空白,提供 73 个可用于生产环境的工具,覆盖整个 WooCommerce REST API v3,并为所有核心资源提供完整的 CRUD 功能。
功能
- 73 个工具,覆盖 18 个类别——目前最全面的 WooCommerce MCP 服务
- 为产品、变体、属性、属性项、类别、标签、评价、订单、客户、优惠券和 Webhook 提供完整的 CRUD 功能
- 库存管理——列出缺货和低库存产品
- 批量操作——单次调用即可批量更新产品和订单
- 报告与分析——销售报告、畅销商品、订单/产品总量
- 商店配置——设置、税种、配送类别、货币、国家/地区
- Webhook 管理——创建、更新、列出和删除 Webhook,以处理实时事件
- 系统诊断——WooCommerce/WordPress 版本、插件、服务器环境
- 安全处理错误——每个工具都封装了错误处理,API 出错时也不会崩溃
- 简单的身份验证——通过环境变量设置 consumer key 和 secret
快速开始
安装
pip install mcp-woocommerce
配置
将 WooCommerce REST API 凭据设置为环境变量:
export WOOCOMMERCE_URL="https://yourstore.com"
export WOOCOMMERCE_KEY="ck_your_consumer_key"
export WOOCOMMERCE_SECRET="cs_your_consumer_secret"
在以下位置生成 API 密钥:WordPress Admin > WooCommerce > Settings > Advanced > REST API
运行
mcp-woocommerce
也可以作为模块运行:
python -m mcp_woocommerce
与 Claude Desktop 搭配使用
添加到 claude_desktop_config.json:
{
"mcpServers": {
"woocommerce": {
"command": "mcp-woocommerce",
"env": {
"WOOCOMMERCE_URL": "https://yourstore.com",
"WOOCOMMERCE_KEY": "ck_your_consumer_key",
"WOOCOMMERCE_SECRET": "cs_your_consumer_secret"
}
}
}
}
与 Claude Code 搭配使用
claude mcp add woocommerce -- mcp-woocommerce
然后在运行 Claude Code 前,在 Shell 中设置环境变量。
工具(73 个)
商店(1 个)
产品(8 个)
| 工具 | 描述 |
|---|
list_products | 根据筛选条件列出产品(状态、类别、搜索、促销状态) |
get_product | 获取完整的产品详情(定价、库存、图片、属性) |
create_product | 创建产品(简单、可变、分组、外部) |
update_product | 更新产品字段(价格、库存、状态等) |
delete_product | 删除产品或将其移至回收站 |
search_products | 按名称或 SKU 搜索 |
list_low_stock_products | 按库存状态列出产品(缺货、延期交货) |
产品类别(4 个)
| 工具 | 描述 |
|---|
list_product_categories | 按层级列出类别 |
create_product_category | 创建类别(可选设置上级类别以创建子类别) |
update_product_category | 更新类别名称、描述、slug、上级类别 |
delete_product_category | 删除类别 |
产品变体(5 个)
| 工具 | 描述 |
|---|
list_product_variations | 列出可变产品的所有变体 |
get_product_variation | 获取完整的变体详情(定价、库存、属性) |
create_product_variation | 创建带有属性和定价的变体 |
update_product_variation | 更新变体价格、库存、状态 |
delete_product_variation | 删除变体 |
产品属性(5 个)
| 工具 | 描述 |
|---|
list_product_attributes | 列出所有属性(例如颜色、尺寸) |
get_product_attribute | 获取属性详情及其属性项 |
create_product_attribute | 创建属性(选择型或文本型) |
update_product_attribute | 更新属性名称、slug、排序方式 |
delete_product_attribute | 从所有产品中删除属性 |
属性术语(4)
| 工具 | 描述 |
|---|
list_attribute_terms | 列出属性的术语(例如,颜色的红色、蓝色) |
create_attribute_term | 向属性添加术语 |
update_attribute_term | 更新术语的名称、别名、描述 |
delete_attribute_term | 删除术语 |
商品标签(3)
| 工具 | 描述 |
|---|
list_product_tags | 列出标签,可选搜索 |
create_product_tag | 创建商品标签 |
delete_product_tag | 删除商品标签 |
商品评价(4)
| 工具 | 描述 |
|---|
list_product_reviews | 列出评价(按商品或状态筛选) |
get_product_review | 获取评价完整详情 |
create_product_review | 创建带评分的评价 |
delete_product_review | 删除评价 |
订单(10)
| 工具 | 描述 |
|---|
list_orders | 列出订单,可按状态、客户、日期范围筛选 |
get_order | 获取订单完整详情(商品、账单、配送、付款) |
create_order | 创建包含订单项的订单 |
update_order_status | 更改订单状态(待处理、处理中、已完成等) |
update_order | 编辑订单账单/配送地址和客户备注 |
delete_order | 删除订单或将其移至回收站 |
list_order_notes | 获取订单的所有备注 |
create_order_note | 添加员工备注或面向客户的备注 |
create_refund | 发起退款 |
list_refunds | 列出订单的所有退款 |
客户(6)
| 工具 | 描述 |
|---|
list_customers | 列出客户,可按角色、搜索条件筛选 |
get_customer | 获取客户完整详情,包括地址和订单统计 |
create_customer | 创建新客户 |
update_customer | 更新客户信息及账单/配送地址 |
delete_customer | 删除客户(可选择重新分配订单) |
search_customers | 按姓名或电子邮件搜索 |
优惠券(5)
| 工具 | 描述 |
|---|
list_coupons | 列出优惠券并搜索 |
get_coupon | 获取优惠券完整详情(限制、限额、使用情况) |
create_coupon | 创建百分比、固定购物车金额或固定商品金额优惠券 |
update_coupon | 更新优惠券金额、到期时间、限额等 |
delete_coupon | 删除优惠券 |
报告(4)
| 工具 | 描述 |
|---|
get_sales_report | 按周期统计销售总额(周、月、年、自定义范围) |
get_top_sellers | 按周期列出最畅销商品 |
get_order_totals | 按状态统计订单数量 |
get_product_totals | 按类型统计商品数量 |
设置(1)
| 工具 | 描述 |
|---|
get_store_settings | 按分组读取商店设置(常规、商品、税费等) |
配送与付款(5)
| 工具 | 描述 |
|---|
list_shipping_zones | 列出配送区域及其配送方式 |
list_payment_gateways | 列出付款网关及其启用状态 |
list_tax_rates | 列出所有已配置的税率 |
list_tax_classes | 列出税种(标准、优惠、零税率) |
list_shipping_classes | 列出商品配送类别 |
Webhook(4)
| 工具 | 描述 |
|---|
list_webhooks | 列出所有 Webhook |
create_webhook | 为订单/商品/客户事件创建 Webhook |
update_webhook | 更新 Webhook URL、主题、状态 |
delete_webhook | 删除 Webhook |
批量操作(2)
| 工具 | 描述 |
|---|
batch_update_products | 在一次调用中批量更新多个商品 |
batch_update_orders | 在一次调用中批量更新多个订单 |
数据(2)
| 工具 | 描述 |
|---|
list_currencies | 列出所有受支持的货币及其代码和符号 |
list_countries | 列出所有国家及其州/省 |
系统(1)
| 工具 | 描述 |
|---|
get_system_status | 获取 WooCommerce/WordPress 版本、插件和服务器环境信息 |
身份验证
WooCommerce 使用消费者密钥 + 消费者密钥进行 REST API 身份验证。此服务通过 HTTPS 使用 HTTP 基本身份验证。
- 前往 WordPress Admin > WooCommerce > Settings > Advanced > REST API
- 点击 Add key
- 将权限设为 Read/Write
- 复制消费者密钥(
ck_...)和消费者密钥(cs_...)
重要: 商店必须使用 HTTPS,基本身份验证才能安全地工作。
要求
- Python 3.10+
- WooCommerce 3.5+,并使用 REST API v3
- 商店已启用 HTTPS
许可证
MIT