WooCommerce MCP Server

WooCommerce MCP Server

site icon
2025.03.08 17
JavaScript电子商务管理WordPress 集成金融服务
WooCommerce MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于与 WooCommerce 商店进行交互。它通过 WordPress REST API 提供全面的工具,用于管理产品、订单、客户、运输、税收、折扣和商店配置等各个方面。该服务使用 JSON-RPC 2.0 协议,兼容 Windows、macOS 和 Linux 系统。
View on GitHub

Overview

基本能力

产品定位

WooCommerce MCP Server 是一个用于与 WooCommerce 商店交互的中间件服务,提供全面的 API 管理功能。

核心功能

  1. WordPress 内容管理:创建、获取、更新和删除 WordPress 文章及其元数据。
  2. WooCommerce 产品管理:全面管理产品、产品类别、标签、属性和变体。
  3. 订单管理:处理订单、订单备注、退款和订单元数据。
  4. 客户管理:管理客户信息及其元数据。
  5. 运输和税收:管理运输区域、方法和税收设置。
  6. 折扣和优惠券:创建和管理优惠券。
  7. 支付网关:获取和更新支付网关信息。
  8. 报告:获取销售、产品、订单、客户等各种报告。
  9. 设置和系统状态:管理商店设置和系统状态工具。

适用场景

  1. 自动化 WooCommerce 商店的产品管理。
  2. 集成第三方系统与 WooCommerce 进行订单处理。
  3. 批量导入或导出产品数据。
  4. 创建自定义报告和分析工具。
  5. 开发自定义的 WooCommerce 管理界面。

工具列表

  1. WordPress 内容管理工具create_post, get_posts, update_post, get_post_meta, update_post_meta, create_post_meta, delete_post_meta
  2. 产品管理工具get_products, get_product, create_product, update_product, delete_product, get_product_meta, create_product_meta, update_product_meta, delete_product_meta
  3. 订单管理工具get_orders, get_order, create_order, update_order, delete_order, get_order_meta, create_order_meta, update_order_meta, delete_order_meta
  4. 客户管理工具get_customers, get_customer, create_customer, update_customer, delete_customer, get_customer_meta, create_customer_meta, update_customer_meta, delete_customer_meta
  5. 运输和税收工具get_shipping_zones, get_shipping_zone, create_shipping_zone, update_shipping_zone, delete_shipping_zone, get_tax_classes, create_tax_class, delete_tax_class
  6. 折扣和优惠券工具get_coupons, get_coupon, create_coupon, update_coupon, delete_coupon
  7. 报告工具get_sales_report, get_products_report, get_orders_report, get_categories_report, get_customers_report, get_stock_report, get_coupons_report, get_taxes_report

常见问题解答

  1. 如何获取 WooCommerce API 密钥? 在 WordPress 仪表盘中,转到 WooCommerce → 设置 → 高级 → REST API 生成密钥。
  2. 是否需要 WordPress 用户名和密码? 只有在使用 WordPress 特定的 API 方法时才需要。
  3. 如何设置环境变量? 可以在 MCP 设置文件中配置,或在请求参数中直接提供。

使用教程

使用依赖

  1. 安装 Node.js 20.0.0 或更高版本
  2. 确保有一个安装了 WooCommerce 插件的 WordPress 站点
  3. 获取 WooCommerce REST API 密钥

安装教程

  1. 克隆仓库
git clone <repository-url>
  1. 安装依赖
npm install
  1. 构建项目
npm run build

配置

在 MCP 设置文件中添加服务器配置,包含环境变量:

{
  "mcpServers": {
    "woocommerce": {
      "command": "node",
      "args": ["path/to/build/index.js"],
      "env": {
        "WORDPRESS_SITE_URL": "https://your-wordpress-site.com",
        "WOOCOMMERCE_CONSUMER_KEY": "your-woocommerce-consumer-key",
        "WOOCOMMERCE_CONSUMER_SECRET": "your-woocommerce-consumer-secret",
        "WORDPRESS_USERNAME": "your-wordpress-username",
        "WORDPRESS_PASSWORD": "your-wordpress-password"
      }
    }
  }
}

调试方式

  1. 确保环境变量已正确设置
  2. 使用示例请求测试 API 功能
  3. 检查日志输出以排查问题

示例测试命令(使用 curl):

curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1,"method":"get_products","params":{"perPage":5}}' http://localhost:<port>

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。