WooCommerce MCP Server

WooCommerce MCP Server

用于将 WooCommerce 商店与 AI 助手及 Task Master 等任务管理系统集成的 MCP（Model Context Protocol）服务。

功能

• 🚀 完整集成 WooCommerce REST API v3
• 🔄 在 WooCommerce 与 Task Master 之间双向同步数据
• 🧠 兼容面向 AI 助手的 MCP 1.0
• 📊 管理商品、订单、客户和分析数据
• 📝 支持 WordPress 内容（文章、SEO）
• 🔔 处理 Webhook，实现响应式同步
• 🛠️ 提供缓存、重试和验证等高级实用工具

目录

• 要求
• 安装
• 快速开始
• 配置
• 与 Task Master 集成
• 使用 Webhook
• Docker
• 开发
• 文档
• 测试
• 问题排查
• 许可证

要求

• Node.js 16.x 或更高版本
• WooCommerce 3.5+，并启用 REST API v3
• 可选：使用 Redis 进行缓存和任务队列管理

安装

使用 npm

# Клонирование репозитория
git clone https://github.com/Vostos007/woocommerce-mcp-server.git

# Установка зависимостей
cd woocommerce-mcp-server
npm install

# Настройка переменных окружения
cp .env.example .env
# Отредактируйте файл .env вашими данными

# Сборка проекта
npm run build

# Запуск сервера
npm start

使用 Docker

# Клонирование репозитория
git clone https://github.com/Vostos007/woocommerce-mcp-server.git
cd woocommerce-mcp-server

# Настройка переменных окружения
cp .env.example .env
# Отредактируйте файл .env вашими данными

# Запуск с помощью Docker Compose
docker-compose up -d

快速开始

1. 获取 WooCommerce API 密钥：

   • 前往 WooCommerce 管理后台 → 设置 → 高级 → REST API
   • 添加具有读写权限的新密钥
   • 复制 Consumer Key 和 Consumer Secret

2. 配置环境变量：

   • 编辑 .env 文件并添加 API 密钥

3. 启动服务：

   npm start
   

4. 检查运行状态：

   # Тестирование соединения с WooCommerce
   node scripts/test-connection.js
   
   # Тестирование API товаров
   node scripts/test-products.js
   
   # Тестирование API заказов
   node scripts/test-orders.js
   

配置

WooCommerce 配置

为确保 WooCommerce API 正常运行，请确认：

1. 您已安装 WooCommerce 3.5 或更高版本
2. 已在 WooCommerce 设置中启用 REST API
3. 已创建具有足够权限的 API 密钥

配置 Redis（可选）

为提升性能和可靠性，您可以启用 Redis 集成：

1. 在您的服务器上安装 Redis，或使用云服务
2. 在 .env 文件中配置连接参数：

   USE_REDIS=true
   REDIS_URL=redis://localhost:6379
   

配置日志级别

您可以在 .env 文件中配置日志级别：

# Доступные уровни: debug, info, warn, error
LOG_LEVEL=info

与 Task Master 集成

要连接到 Task Master 任务管理系统：

1. 在 .env 中配置 Task Master 参数：

   TASK_MASTER_URL=http://your-task-master-url.com
   TASK_MASTER_API_KEY=your-api-key
   

2. 配置自动同步：

   • 在 Task Master 中为 WooCommerce 创建项目
   • 复制项目 ID 并将其添加到 Webhook 设置中
   • 配置 Webhook 以跟踪变更

有关 Task Master 集成的详细说明，请参阅集成文档。

使用 Webhook

WooCommerce MCP Server 支持 Webhook，可响应式地更新数据。

配置 WooCommerce Webhook

1. 在 .env 文件中添加 Webhook 设置：

   WEBHOOK_SECRET=your-webhook-secret
   

2. 使用脚本创建 Webhook：

   node scripts/setup-webhooks.js
   

3. 或使用 Webhook 管理工具：

   import { WebhookManager } from './src/utils/webhooks';
   
   const webhookManager = new WebhookManager(wooConfig, 'your-secret');
   await webhookManager.setupTaskMasterWebhooks('https://your-server.com/webhooks');
   

Docker

使用 Docker 进行本地开发

# Запуск в режиме разработки
docker-compose up

生产环境部署

# Сборка производственного образа
docker build -t woocommerce-mcp-server:latest .

# Запуск контейнера
docker run -p 3000:3000 --env-file .env woocommerce-mcp-server:latest

Docker 环境变量

您可以直接在 docker run 中传递环境变量：

docker run -p 3000:3000 \
  -e WOOCOMMERCE_URL=https://your-store.com \
  -e WOOCOMMERCE_KEY=your-key \
  -e WOOCOMMERCE_SECRET=your-secret \
  woocommerce-mcp-server:latest

开发

项目结构

/woocommerce-mcp-server
  /docs                      # Документация
  /scripts                   # Вспомогательные скрипты
  /src
    /tools                   # Инструменты для работы с API
      products.ts            # Функции для работы с товарами
      orders.ts              # Функции для работы с заказами
      customers.ts           # Функции для работы с клиентами
      analytics.ts           # Функции для аналитики
      posts.ts               # Функции для работы со статьями
      seo.ts                 # Функции для работы с SEO
    /utils                   # Утилиты
      woocommerce.ts         # Клиент для WooCommerce API
      wordpress.ts           # Клиент для WordPress API
      seo-plugin.ts          # Утилиты для работы с SEO
      validation.ts          # Утилиты для валидации данных
      cache.ts               # Утилиты для кэширования
      retry.ts               # Утилиты для повторных попыток
      webhooks.ts            # Утилиты для вебхуков
      task-master.ts         # Адаптер для интеграции с Task Master
    /types                   # Типы TypeScript
      woocommerce.d.ts       # Типы данных WooCommerce
      wordpress.d.ts         # Типы данных WordPress
    index.ts                 # Точка входа
  .env.example               # Пример переменных окружения
  Dockerfile                 # Описание Docker-образа
  docker-compose.yml         # Конфигурация Docker Compose

以开发模式运行

# Запуск с поддержкой автоматической перезагрузки
npm run dev

代码风格和 lint

本项目使用 ESLint 和 Prettier 来保持统一的代码风格：

# Проверка стиля кода
npm run lint

# Автоматическое форматирование кода
npm run format

文档

更多文档可在 /docs 目录中查看：

• WooCommerce API v3 文档
• MCP 与 Task Master 集成

测试

# Запуск всех тестов
npm test

# Запуск тестов с отчетом о покрытии
npm run test:coverage

问题排查

Проблемы с подключением к WooCommerce API

1. Убедитесь, что URL магазина указан правильно и доступен
2. Проверьте ключ и секрет API
3. Убедитесь, что у ключа API достаточно прав
4. Проверьте, что API WooCommerce включен и работает

Ошибки интеграции с Task Master

1. Проверьте доступность Task Master по указанному URL
2. Убедитесь, что API-ключ Task Master указан правильно
3. Проверьте настройки проекта и права доступа

Логи и отладка

Для более подробной диагностики проблем, включите отладочное логирование:

LOG_LEVEL=debug

Дополнительная помощь

Если у вас возникли проблемы, создайте issue в репозитории проекта или обратитесь к документации.

Лицензия

Этот проект распространяется под лицензией MIT. Подробности в файле LICENSE.