woo MCP

WooCommerce MCP服务器

用于WooCommerce集成的模型上下文协议（MCP）服务器，与Windows、macOS和Linux兼容。

概述

此MCP服务器通过WordPress REST API实现与WooCommerce商店的交互。它提供了全面的工具，用于使用JSON-RPC 2.0协议管理产品、订单、客户、运输、税务、折扣和商店配置的各个方面。

相关项目

向8亿多ChatGPT用户展示您的WooCommerce商店！ 结账 WooCommerce聊天GPT应用程序 -使用MCP和ChatGPT SDK构建的可视化购物助手，具有显示产品、图像、价格和描述的漂亮UI。浏览、搜索、过滤和无缝导航到您的商店-所有这些都在ChatGPT中。

安装-WooCommerce MCP服务器

1. 克隆存储库
2. 安装依赖项：

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

环境变量

WooCommerce API访问需要：

• WORDPRESS_SITE_URL：您的WordPress网站URL（WooCommerce是一个WordPress插件）
• WOOCOMMERCE_CONSUMER_KEY：WooCommerce REST API消费者密钥
• WOOCOMMERCE_CONSUMER_SECRET：WooCommerce REST API消费者机密

仅适用于WordPress API方法：

• WORDPRESS_USERNAME：具有适当权限的WordPress用户名
• WORDPRESS_PASSWORD：用于身份验证的WordPress密码

如果您不想使用环境变量，也可以在请求参数中提供这些凭据。

身份验证选项

WooCommerce身份验证

WooCommerce API访问需要消费者密钥，您可以在WooCommCommerce下的WordPress仪表板中生成这些密钥→ 设置→ 高级→ REST API。

WordPress身份验证

对于WordPress特定的方法（如管理帖子），您需要提供：

• 用于基本身份验证的用户名/密码凭据
• 必须在您的网站上启用WordPress REST API

API方法

服务器同时支持WordPress和WooCommerce API方法。以下是按类别分组的可用方法列表：

WordPress内容管理

这些方法需要WordPress用户名/密码凭据，并且独立于WooCommerce API。

WooCommerce产品

产品分类

产品标签

产品属性

产品变体

产品评论

WooCommerce订单

订单备注

订单退款

WooCommerce客户

运输

税收

折扣/优惠券

支付网关

报告

设置

系统状态

数据

方法参数

所有方法都遵循类似的参数结构。以下是一些示例：

所有方法的通用参数

• siteUrl：（如果在env中设置，则可选）WordPress站点URL

WooCommerce方法的附加参数

• consumerKey：（如果在env中设置，则可选）WooCommerce消费者密钥
• consumerSecret：（如果在env中设置，则可选）WooCommerce消费者机密

WordPress方法的附加参数

• username：（如果在env中设置，则可选）WordPress用户名
• password：（可选，如果在env中设置）WordPress密码

示例用法

WordPress API示例

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "create_post",
  "params": {
    "siteUrl": "https://your-wordpress-site.com",
    "username": "your-wordpress-username",
    "password": "your-wordpress-password",
    "title": "My New Blog Post",
    "content": "This is the content of my new blog post.",
    "status": "publish"
  }
}

WooCommerce产品示例

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "get_products",
  "params": {
    "perPage": 20,
    "page": 1,
    "filters": {
      "category": 19,
      "status": "publish"
    }
  }
}

创建产品示例

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "create_product",
  "params": {
    "productData": {
      "name": "Premium T-Shirt",
      "type": "simple",
      "regular_price": "29.99",
      "description": "Comfortable cotton t-shirt, available in various sizes.",
      "short_description": "Premium quality t-shirt.",
      "categories": [
        {
          "id": 19
        }
      ],
      "images": [
        {
          "src": ""
        }
      ]
    }
  }
}

产品元数据示例

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "create_product_meta",
  "params": {
    "productId": 456,
    "metaKey": "_custom_product_field",
    "metaValue": {
      "special_attribute": "value",
      "another_attribute": 42
    }
  }
}

订单元数据示例

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "create_order_meta",
  "params": {
    "orderId": 789,
    "metaKey": "_delivery_instructions",
    "metaValue": "Leave package at the back door"
  }
}

安全说明

对于WooCommerce REST API访问，您需要生成API密钥。您可以在WooCommerce下的WordPress仪表板中创建它们→ 设置→ 高级→ REST API。

需求

• Node.js 20.0.0或更高版本
• 安装了WooCommerce插件的WordPress网站
• WooCommerce REST API密钥

许可证

MIT许可证-有关详细信息，请参阅许可证文件