项目简介

'ai-experiments' 仓库是Automattic的AI实验项目,其中 '/mcp/woo' 目录包含了 WooCommerce MCP 服务器的实现。该服务器旨在通过 Model Context Protocol (MCP) 协议,为 AI 助手提供一个标准化的接口,使其能够以自然语言指令与 WooCommerce 商店进行交互,实现店铺管理和自动化操作。

主要功能点

  • 工具化 API: 将 WooCommerce 的各种功能(如商品、订单、顾客管理等)封装成一系列可被 AI 助手调用的工具 (Tools)。
  • 全面的 WooCommerce 功能覆盖: 提供丰富的工具集,涵盖商品管理、订单处理、顾客信息管理、优惠券、税务、运费、支付网关、退款等 WooCommerce 核心功能。
  • 基于 JSON-RPC 通信: 使用 JSON-RPC 协议通过标准输入/输出 (Stdio) 与 MCP 客户端进行通信。
  • 环境配置: 通过环境变量配置 WooCommerce API 的连接信息,包括 API URL、消费者密钥和消费者 secret。
  • 易于扩展的工具集: 采用模块化设计,方便开发者根据需要扩展和添加新的 WooCommerce 功能工具。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/Automattic/ai-experiments.git
    cd ai-experiments/mcp/woo
  2. 安装依赖: 确保已安装 Node.js 和 npm。
    npm install
  3. 配置环境变量: 在 'mcp/woo' 目录下创建 '.env' 文件,并根据你的 WooCommerce 商店信息填写以下环境变量:
    WOOCOMMERCE_API_URL=your_woocommerce_store_url.com      # 你的 WooCommerce 商店 URL (例如: https://yourstore.com)
    WOOCOMMERCE_CONSUMER_KEY=your_consumer_key             # WooCommerce API 消费者密钥
    WOOCOMMERCE_CONSUMER_SECRET=your_consumer_secret          # WooCommerce API 消费者 secret
    # WOOCOMMERCE_INSECURE_HTTP=true                        # 如果你的 WooCommerce API URL 以 http:// 开头,设置为 true (仅用于开发环境,生产环境不推荐)
    注意: 'WOOCOMMERCE_CONSUMER_KEY' 和 'WOOCOMMERCE_CONSUMER_SECRET' 需要在你的 WooCommerce 管理后台的 "WooCommerce" -> "设置" -> "高级" -> "REST API" 中创建。创建 API 密钥时,权限请设置为 "读取/写入"。

服务器配置 (MCP 客户端配置)

为了使 MCP 客户端能够连接到此服务器,需要在客户端配置服务器的启动信息。以下是一个 JSON 格式的配置示例,请添加到你的 MCP 客户端配置中:

{
  "serverName": "woocommerce",             // 服务器名称,可以自定义,用于在客户端识别和管理
  "command": "node",                       // 启动服务器的命令,这里使用 node.js 运行时
  "args": [ "dist/server.js" ],            // 命令参数,指向编译后的服务器入口文件
  "transport": "stdio"                     // 通信方式,这里使用标准输入输出流 (stdio)
}

基本使用方法

  1. 启动服务器: 在 'mcp/woo' 目录下,运行以下命令启动服务器:
    npm run start
    服务器将在后台运行,并通过标准输入/输出等待 MCP 客户端的请求。
  2. MCP 客户端连接: 配置你的 MCP 客户端,使用上面提供的服务器配置 JSON 连接到 WooCommerce MCP 服务器。
  3. 调用工具: 连接成功后,MCP 客户端可以向服务器发送 JSON-RPC 请求来调用各种 WooCommerce 工具。例如,要列出所有商品,客户端可以调用 'list_products' 工具。可用的工具及其参数定义在 'src/tools' 目录下的各个文件中。

信息

分类

商业系统