项目简介

这是一个基于 Model Context Protocol (MCP) 构建的服务器端应用,专门用于与 WooCommerce 商店进行交互。它让支持 MCP 协议的大型语言模型(LLM)客户端能够通过标准化的方式,访问和管理 WooCommerce 的商品、订单、客户等信息。

主要功能点

提供全面的 WooCommerce 和 WordPress 数据访问与管理能力,包括:

  • 商品管理: 获取、创建、更新、删除商品,管理商品分类、标签、属性、变体和评价。
  • 订单管理: 获取、创建、更新、删除订单,管理订单备注和退款。
  • 客户管理: 获取、创建、更新、删除客户。
  • 商店设置: 管理运费区域、运费方式、税率、优惠券、支付网关和商店通用设置。
  • 商店报告: 获取销售、商品、订单、客户、库存、优惠券和税务等各类报告。
  • 系统状态: 获取商店系统状态信息,运行系统工具。
  • 基础数据: 获取大陆、国家、货币等基础数据。
  • 元数据操作: 对商品、订单和客户进行元数据(自定义字段)的获取、添加、更新和删除操作。
  • WordPress 内容管理: 获取、创建、更新、删除 WordPress 文章,管理文章元数据(需要额外的 WordPress 用户名/密码)。

安装步骤

  1. 克隆项目代码到您的本地或服务器环境。
  2. 打开终端或命令提示符,进入项目代码所在的目录。
  3. 运行 'npm install' 命令安装项目依赖。
  4. 运行 'npm run build' 命令构建项目,这会生成可执行的 JavaScript 文件。

服务器配置(供 MCP 客户端使用)

为了让 MCP 客户端能够连接和使用此服务器,您需要将其添加到客户端的 MCP 服务器配置文件中。配置通常是一个 JSON 对象,指定服务器的名称、启动命令、参数以及必要的环境变量或默认参数。

例如,您可以设置一个名为 'woocommerce' 的服务器,其 'command' 是 'node','args' 是指向构建后主文件的路径(例如 'path/to/build/index.js')。

同时,需要在配置的 'env' 部分或请求参数中提供连接到您的 WordPress/WooCommerce 网站所需的凭据:

  • 'WORDPRESS_SITE_URL': 必填,您的 WordPress 网站地址(WooCommerce 是 WordPress 插件)。
  • 'WOOCOMMERCE_CONSUMER_KEY': 必填,WooCommerce REST API 的 Consumer Key。
  • 'WOOCOMMERCE_CONSUMER_SECRET': 必填,WooCommerce REST API 的 Consumer Secret。
  • 'WORDPRESS_USERNAME' 和 'WORDPRESS_PASSWORD': 可选,仅在需要调用 WordPress 自身的 API 方法(如文章管理)时需要,提供具有相应权限的 WordPress 用户名和密码。

WooCommerce API 凭据(Consumer Key 和 Secret)需要在您的 WordPress 后台 WooCommerce -> 设置 -> 高级 -> REST API 中生成。请确保生成的密钥具有足够的权限(至少需要读/写权限)。

基本使用方法

配置完成后,支持 MCP 协议的 LLM 客户端即可通过调用该服务器暴露的方法与您的 WooCommerce 商店进行交互。

LLM 客户端会通过标准化的 JSON-RPC 请求调用服务器暴露的特定方法(Method),例如调用 'get_products' 方法来获取商品列表,调用 'create_order' 方法来创建新订单。

每个方法需要提供相应的参数,例如获取特定商品需要提供 'productId' 参数,创建商品需要提供包含商品详情的 'productData' 参数。连接凭据也可以作为参数在每次请求中提供,但通常建议通过服务器配置的环境变量设置默认值以提高安全性。

服务器会处理这些请求,调用底层的 WooCommerce/WordPress REST API 执行相应的操作,并将 API 返回的数据作为 JSON-RPC 响应的 'result' 返回给客户端。如果操作失败,服务器将返回包含错误信息的 JSON-RPC 响应。

信息

分类

商业系统