WooCommerce MCP 服务器

一个用于将 WooCommerce 与 Claude 和其他 AI 助手集成的模型上下文协议 (MCP) 服务器。

概述

此服务器为 AI 助手提供与 WooCommerce 商店交互的工具，允许它们：

• 获取最近的订单，并可选择进行过滤
• 通过 ID 检索有关特定订单的详细信息

该服务器实现了 模型上下文协议 规范，使其与支持 MCP 的 AI 助手（如 Claude for Desktop）兼容。

前提条件

• Node.js v18 或更高版本
• 具有 REST API 访问权限的 WooCommerce 商店
• WooCommerce API 凭据（消费者密钥和密钥）

安装

1. 克隆此存储库：

git clone https://github.com/techspawn/woocommerce-mcp-server.git
cd woocommerce-mcp-server

2. 安装依赖项：

npm install

配置

您需要配置您的 WooCommerce API 凭据。您可以通过以下方式进行配置：

1. 在运行服务器时设置环境变量：

WOOCOMMERCE_URL=https://your-store.com \
WOOCOMMERCE_CONSUMER_KEY=your-consumer-key \
WOOCOMMERCE_CONSUMER_SECRET=your-consumer-secret \
node index.js

2. 或者通过编辑 index.js 文件中的默认值：

const woocommerceConfig = {
  url: process.env.WOOCOMMERCE_URL || 'https://your-store.com',
  consumerKey: process.env.WOOCOMMERCE_CONSUMER_KEY || 'your-consumer-key',
  consumerSecret: process.env.WOOCOMMERCE_CONSUMER_SECRET || 'your-consumer-secret',
  version: 'wc/v3'
};

运行服务器

要直接运行服务器：

node index.js

或者使用 npm 脚本：

npm start

与 Claude for Desktop 集成

要将此服务器连接到 Claude for Desktop：

1. 确保您已安装 Claude for Desktop

2. 打开您的 Claude Desktop 配置文件，该文件位于：

   • Windows: %USERPROFILE%\AppData\Roaming\Claude\claude_desktop_config.json
   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Linux: ~/.config/Claude/claude_desktop_config.json

3. 添加您的 WooCommerce MCP 服务器配置（如果文件不存在，请创建它）：

{
  "mcpServers": {
    "woocommerce": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/TO/woocommerce-mcp-server/index.js"
      ],
      "env": {
        "WOOCOMMERCE_URL": "https://your-store.com",
        "WOOCOMMERCE_CONSUMER_KEY": "your-consumer-key",
        "WOOCOMMERCE_CONSUMER_SECRET": "your-consumer-secret"
      }
    }
  }
}

4. 保存文件并重启 Claude for Desktop

可用工具

getRecentOrders

从您的 WooCommerce 商店获取最近的订单列表。

参数：

• status（可选）：按状态过滤订单（例如，“processing”、“completed”、“on-hold”）
• limit（可选，默认值：5）：要返回的订单数量

getOrderById

检索有关特定订单的详细信息。

参数：

• id：要检索的订单 ID

使用 JavaScript 构建您自己的 MCP 服务器

本节提供了一个使用 JavaScript/Node.js 创建您自己的 MCP 服务器的指南。

1. 设置一个新项目

mkdir my-mcp-server
cd my-mcp-server
npm init -y

2. 安装依赖项

npm install @modelcontextprotocol/sdk axios zod

3. 创建您的服务器文件 (index.js)

从基本结构开始：

import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";

// 初始化服务器
const server = new McpServer({
  name: "My MCP Service",
  version: "1.0.0",
});

// 定义和注册您的工具
server.tool(
  "myToolName",
  {
    // 使用 Zod 模式定义参数
    param1: z.string().describe("Description of param1"),
    param2: z.number().optional().describe("Optional parameter")
  },
  async ({ param1, param2 }) => {
    // 工具实现逻辑在这里
    const result = `Processed ${param1} with value ${param2 || 'none'}`;
    
    // 以预期格式返回结果
    return {
      content: [
        {
          type: "text",
          text: result
        }
      ]
    };
  }
);

// 连接服务器
const transport = new StdioServerTransport();
await server.connect(transport);

4. 使您的 package.json 与 ES 模块兼容

{
  "type": "module",
  "scripts": {
    "start": "node index.js"
  }
}

5. 定义工具

MCP 工具由三个组件定义：

• 名称：工具的唯一标识符
• 参数：输入参数的模式（使用 Zod）
• 处理程序：处理输入并返回结果的异步函数

示例：

server.tool(
  "calculateTotal",
  {
    items: z.array(
      z.object({
        name: z.string(),
        price: z.number(),
        quantity: z.number().int().positive()
      })
    ).describe("Array of items to calculate total for")
  },
  async ({ items }) => {
    const total = items.reduce((sum, item) => sum + (item.price * item.quantity), 0);
    
    return {
      content: [
        {
          type: "text",
          text: `Total: $${total.toFixed(2)}`
        }
      ]
    };
  }
);

6. 本地测试

您可以使用 stdio 传输在本地测试您的 MCP 服务器：

node index.js

7. 调试技巧

• 使用 console.error() 进行调试，而不是 console.log()，后者会干扰 stdio 传输
• 检查 Claude for Desktop 中的日志以查找错误
• 确保您的工具处理程序正确处理异常

资源

• 模型上下文协议文档
• MCP JavaScript SDK
• WooCommerce REST API 文档

许可证

MIT