Back to MCP directory
publicPublicdnsLocal runtime

woocommerce-mcp-server-project

一个基于HTTP/Express的WooCommerce JSON-RPC 2.0接口服务,提供产品查询和更新功能。

article

README

🚀 WooCommerce MCP 服务器(HTTP/Express)

此服务器借助 HTTP 提供 JSON - RPC 2.0 接口,用于与 WooCommerce 进行交互,为开发者提供便捷的方式来管理和操作 WooCommerce 相关业务。

🚀 快速开始

安装指南

克隆仓库

若你还未克隆该仓库,请先进行克隆操作。

进入项目目录

cd woocommerce-mcp-server-http

安装依赖项

npm install

创建 .env 文件

在当前目录下创建一个名为 .env 的文件,并添加以下变量,记得用实际凭证替换占位符的值:

# 你的 WooCommerce 网站 URL
WORDPRESS_SITE_URL=https://your-woocommerce-site.com

# WooCommerce API 密钥
WOOCOMMERCE_CONSUMER_KEY=ck_your_consumer_key
WOOCOMMERCE_CONSUMER_SECRET=cs_your_consumer_secret

# MCP 服务器端口(默认:3000)
PORT=3000

# 访问此 MCP 服务器的机密 API 键
MCP_API_KEY=your_secret_api_key_here 

运行服务器

node server.js

服务器启动后,你会看到如下提示:

✅ MCP HTTP(Express)服务器在 http://localhost:3000 上线
   RPC 端点可通过 http://localhost:3000/rpc 访问

💻 使用示例

基础用法

在使用示例命令前,请将 your_secret_api_key_here 替换为你在 .env 文件中设置的 MCP_API_KEY 实际值。

获取产品(前 3 个)

curl -X POST http://localhost:3000/rpc \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_secret_api_key_here" \
  -d '{"jsonrpc":"2.0","method":"get_products","params":{"perPage":3},"id":1}'

获取特定产品(ID:4644)

curl -X POST http://localhost:3000/rpc \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_secret_api_key_here" \
  -d '{"jsonrpc":"2.0","method":"get_product","params":{"productId":4644},"id":2}'

高级用法

更新产品描述(使用 payload-http.json

首先,确保 payload-http.json 文件存在,且包含如下内容:

{
  "jsonrpc": "2.0",
  "method": "update_product",
  "params": {
    "productId": 4644,
    "productData": {
      "description": "这是更新后的描述。"
    }
  },
  "id": 3
}

然后运行以下命令:

curl -X POST http://localhost:3000/rpc \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_secret_api_key_here" \
  -d @payload-http.json

⚠️ 重要提示

当前服务器使用了一个占位符函数 handleWooCommerceRequest,实际的 WooCommerce 集成需要在此处实现。

help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client