使用说明
WooCommerce MCP服务器
用于无缝集成WooCommerce的模型上下文协议(MCP)服务器,使AI助手能够通过自然语言与您的WooCommerce商店进行交互。
特性
- 产品管理:创建、读取、更新和删除产品,完全支持变体、类别和属性
- 订单处理:检索和管理订单,更新订单状态,处理订单履行
- 客户管理:访问客户数据、管理客户帐户和查看购买历史记录
- 库存控制:监控库存水平、更新库存和管理产品可用性
- 分析和报告:访问商店分析、销售报告和绩效指标
- 类别和标签管理:用类别和标签组织产品
- 优惠券管理:创建和管理折扣码和促销优惠
- 存储配置:访问和修改商店设置和配置选项
安装
- 克隆存储库:
git clone https://github.com/faizan45640/WooCommerce-MCP-Server.git
cd WooCommerce-MCP-Server
- 安装依赖项:
npm install
- 创建一个
.env文件中包含您的WooCommerce凭据:
WOOCOMMERCE_URL=https://your-store.com
WOOCOMMERCE_CONSUMER_KEY=your_consumer_key
WOOCOMMERCE_CONSUMER_SECRET=your_consumer_secret
- 启动服务器:
npm start
用法
发展
npm run dev
生产
npm start
配置
创建一个 .env 根目录中的文件,包含以下变量:
# WooCommerce Store Configuration
WOOCOMMERCE_URL=https://your-store.com
WOOCOMMERCE_CONSUMER_KEY=your_consumer_key
WOOCOMMERCE_CONSUMER_SECRET=your_consumer_secret
WOOCOMMERCE_API_VERSION=v3
# MCP Server Configuration
MCP_SERVER_PORT=3000
LOG_LEVEL=info
获取WooCommerce API证书
- 转到您的WordPress管理仪表板
- 导航到WooCommerce→ 设置→ 高级→ REST API
- 点击“添加密钥”
- 设置描述(例如“MCP服务器”)
- 选择用户和权限(建议读/写)
- 点击“生成API密钥”
- 将消费者密钥和消费者秘密复制到您的
.env文件
可用工具
MCP服务器提供以下工具:
产品
get_products-使用筛选选项检索产品get_product-按ID获取特定产品create_product-创建新产品update_product-更新现有产品delete_product-删除产品search_products-按术语搜索产品get_product_categories-获取产品类别
订单
get_orders-使用筛选选项检索订单get_order-按ID获取特定订单create_order-创建新订单update_order-更新订单详细信息update_order_status-更新订单状态get_recent_orders-获取最近的订单get_order_stats-获取订单统计信息add_order_note-为订单添加注释
客户
get_customers-检索客户列表get_customer-获取特定客户详细信息create_customer-创建新客户update_customer-更新客户信息search_customers-搜索客户get_customer_by_email-通过电子邮件查找客户get_customer_orders-获取客户订单get_customer_stats-获取客户统计数据get_top_customers-获得顶级消费客户get_new_customers-获取最近注册的客户
库存
check_stock-检查产品库存水平update_stock-更新产品库存get_low_stock_products-获得低库存产品get_out_of_stock_products-缺货产品get_stock_report-获取全面的库存报告bulk_update_stock-更新多个产品的库存
Claude Desktop使用示例
将此服务器添加到您的Claude Desktop配置中:
{
"mcpServers": {
"woocommerce": {
"command": "node",
"args": ["path/to/WooCommerce-MCP-Server/src/index.js"]
}
}
}
然后,您可以使用自然语言与WooCommerce商店进行交互:
- “按销售额显示前10名产品”
- “创造一款名为‘高级T恤’的新产品,售价25美元”
- 将订单#123的状态更新为“已完成”
- “列出本月购买的所有客户”
- “检查哪些产品库存不足”
- “给我一份今天订单的摘要”
发展
项目结构
src/
├── index.js # Main server entry point
├── services/
│ ├── woocommerce.js # WooCommerce API client
│ ├── products.js # Product management service
│ ├── orders.js # Order management service
│ └── customers.js # Customer management service
├── tools/
│ ├── index.js # Tool registry
│ ├── products/ # Product-related tools
│ ├── orders/ # Order-related tools
│ ├── customers/ # Customer-related tools
│ └── inventory/ # Inventory-related tools
└── utils/
├── validation.js # Input validation utilities
└── logger.js # Logging utilities
tests/ # Test files
运行测试
npm test
掉毛
npm run lint
npm run lint:fix
环境变量
| 变量 | 描述 | 默认值 | 必填 |
|---|---|---|---|
WOOCOMMERCE_URL |
您的WooCommerce商店URL | - | 是 |
WOOCOMMERCE_CONSUMER_KEY |
API用户密钥 | - | 是 |
WOOCOMMERCE_CONSUMER_SECRET |
API消费者秘密 | - | 是 |
WOOCOMMERCE_API_VERSION |
API版本 | v3 |
没有 |
LOG_LEVEL |
日志记录级别 | info |
没有 |
MCP_SERVER_PORT |
服务器端口 | 3000 |
没有 |
错误处理
服务器包括全面的错误处理:
- 所有工具参数的输入验证
- WooCommerce API错误响应
- 连接和超时处理
- 详细的错误记录
安全
- 使用OAuth 1.0a进行安全的API身份验证
- 输入验证以防止注入攻击
- 日志中没有敏感数据
- 环境变量配置
贡献
- 分叉存储库
- 创建要素分支:
git checkout -b feature-name - 进行更改并添加测试
- 运行测试:
npm test - 提交您的更改:
git commit -am 'Add feature' - 推到分支:
git push origin feature-name - 提交拉取请求
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
支持
如需支持,请在 GitHub存储库.
路线图
- []支持WooCommerce订阅
- []高级报告和分析
- []产品和订单的批量操作
- []与支付网关集成
- []多店铺支持
- []Webhook支持实时更新
- []GraphQL API支持
- []速率限制和缓存
- []Docker容器化