Woocommerce MCP Server

🚀 WooCommerce MCP プロジェクトドキュメント

このプロジェクトは、WooCommerce と連携するための便利なツールキットです。必要な機能を簡単に実装でき、開発効率を大幅に向上させます。

🚀 クイックスタート

このセクションでは、WooCommerce MCP プロジェクトをローカル環境にインストールし、実行するための基本的な手順を説明します。

📦 インストール

インストール手順

1. このリポジトリをローカル開発環境にクローンします：

   git clone https://github.com/yourusername/woocommerce-mcp.git
   cd woocommerce-mcp
   

2. Node.js を使用して依存関係をインストールします：

   npm install
   

3. 環境変数を設定します。.env.example ファイルをコピーして .env という名前にします：

   cp .env.example .env
   

環境変数の設定

.env ファイルに以下の情報を記入します：

• WOOCOMMERCE_URL: WooCommerce インスタンスの URL を指定します（例：https://your-store.com）
• WOOCOMMERCE_KEY: WooCommerce API の開発者キーを指定します
• WOOCOMMERCE_SECRET: WooCommerce API に対応するキーを指定します

💻 使用例

開発モードでの実行

npm run dev

本番モードでの実行

npm start

Docker でのデプロイ

イメージのビルド

docker build -t woocommerce-mcp-server:latest .

コンテナの実行

docker run -p 3000:3000 --env-file .env woocommerce-mcp-server:latest

📚 ドキュメント

プロジェクト構造

/woocommerce-mcp
  /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            # Webhook 関連機能
      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 の設定ファイル

開発ガイド

コードスタイルとフォーマット

プロジェクトでは ESLint と Prettier を使用してコードスタイルを統一しています：

# コードスタイルのチェック
npm run lint

# コードの自動フォーマット
npm run format

テスト

# すべてのテストを実行
npm test

# カバレッジレポート付きのテスト
npm run test:coverage

プロジェクトツール

• Docker：コンテナ化されたデプロイに使用
• Node.js：プロジェクトの実行環境
• ESLint と Prettier：コード品質管理ツール

トラブルシューティング

一般的な問題

1. 環境変数の設定エラー：
   • .env ファイル内のパラメータが正しく入力されていることを確認してください。
2. Docker デプロイが失敗した場合：
   • Docker サービスが起動していること、およびコンテナを実行するための十分な権限があることを確認してください。

ドキュメントの拡張

詳細情報については、プロジェクトの README ファイルを参照するか、関連する技術ドキュメントを閲覧してください。