WooCommerce MCP Server

WooCommerce MCP サーバー

WooCommerce ストアを AI アシスタントや Task Master などのタスク管理システムと統合するための MCP（Model Context Protocol）サーバーです。

機能

• 🚀 WooCommerce REST API v3 との完全な統合
• 🔄 WooCommerce と Task Master 間の双方向データ同期
• 🧠 AI アシスタント向けの MCP 1.0 互換性
• 📊 商品、注文、顧客、分析の管理
• 📝 WordPress コンテンツ（記事、SEO）のサポート
• 🔔 リアクティブな同期を実現するウェブフック処理
• 🛠️ キャッシュ、再試行、検証のための高度なユーティリティ

目次

• 要件
• インストール
• クイックスタート
• 設定
• Task Master との統合
• ウェブフックの使用
• Docker
• 開発
• ドキュメント
• テスト
• トラブルシューティング
• ライセンス

要件

• Node.js 16.x 以降
• REST API v3 対応の WooCommerce 3.5 以降
• オプション：キャッシュとタスクキュー用の 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. 自動同期を設定する：

   • WooCommerce 用のプロジェクトを Task Master に作成します
   • プロジェクト ID をコピーし、ウェブフックの設定に追加します
   • 変更を追跡するようウェブフックを設定します

Task Master との統合手順の詳細は、統合ドキュメントをご覧ください。

ウェブフックの使用

WooCommerce MCP Server は、データをリアクティブに更新するためのウェブフックをサポートしています。

WooCommerce ウェブフックの設定

1. .env ファイルにウェブフックの設定を追加します：

   WEBHOOK_SECRET=your-webhook-secret
   

2. スクリプトを使用してウェブフックを作成します：

   node scripts/setup-webhooks.js
   

3. または、ウェブフック管理ユーティリティを使用します：

   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

コードスタイルとリンティング

このプロジェクトでは、コードスタイルを統一するために 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.