🚀 Chatterbox MCP Server

🚀 Chatterbox MCP サーバー（MCPHubによってインデックス化・認定済み）

このリポジトリには、主に2つのコンポーネントが含まれています。

🤖 MCP サーバー（mcp_server/）

MCP ツールを通じて WhatsApp の機能を提供する Model Context Protocol サーバーです。

主なファイル：

• mcp_server/src/server.ts - メインの MCP サーバー
• mcp_server/src/model/tools.ts - WhatsApp 操作用の MCP ツール
• mcp_server/src/model/resources.ts - MCP リソース

使用方法：

cd mcp_server
npm install
npm run dev

📱 WhatsApp サーバー（whatsappServer/）

WhatsApp Web との実際の連携を処理する REST API サーバーです。

主なファイル：

• whatsappServer/src/server.ts - メインの Express サーバー
• whatsappServer/src/services/whatsappService.ts - WhatsApp Web.js との連携
• whatsappServer/src/controllers/whatsappController.ts - API エンドポイント

使用方法：

cd whatsappServer
npm install
npm run dev

🔧 アーキテクチャ

┌─────────────────┐    HTTP API    ┌─────────────────┐
│                 │    Calls       │                 │
│   MCP Server    │ ─────────────► │ WhatsApp Server │
│                 │                │                 │
└─────────────────┘                └─────────────────┘
        │                                   │
        │                                   │
        ▼                                   ▼
┌─────────────────┐                ┌─────────────────┐
│  MCP Client     │                │  WhatsApp Web   │
│  (Claude, etc)  │                │                 │
└─────────────────┘                └─────────────────┘

📁 プロジェクト構成

chatterbox_mcp_server/
├── mcp_server/
│   ├── src/
│   ├── secrets/                    # Secret files for MCP server
│   │   ├── CHATTERBOX_SECRET
│   │   └── WHATSAPP_SERVER_URL
│   └── package.json
├── whatsappServer/
│   ├── src/
│   ├── secrets/                    # Secret files for WhatsApp server
│   │   ├── CHATTERBOX_SECRET
│   │   ├── PORT
│   │   └── HEADLESS
│   └── package.json
└── package.json

🚀 クイックスタート

1. シークレットを設定します：

   # MCP Server secrets (in mcp_server/secrets/)
   echo "your_secret_here" > mcp_server/secrets/CHATTERBOX_SECRET
   echo "http://localhost:3004" > mcp_server/secrets/WHATSAPP_SERVER_URL
   
   # WhatsApp Server secrets (in whatsappServer/secrets/)
   echo "your_secret_here" > whatsappServer/secrets/CHATTERBOX_SECRET
   echo "3004" > whatsappServer/secrets/PORT
   echo "true" > whatsappServer/secrets/HEADLESS
   

2. 依存関係をインストールします：

   npm run install:all
   

3. WhatsApp サーバーを起動します：

   npm run dev:whatsapp
   

4. MCP サーバーを起動します：

   npm run dev:mcp
   

5. WhatsApp を認証します：

   • QR コードを取得するには、http://localhost:3004/qr にアクセスします
   • WhatsApp モバイルアプリでスキャンします

🛠️ 開発

各コンポーネントは個別に開発できます。

• MCP サーバーは MCP プロトコルの実装に重点を置いています
• WhatsApp サーバーは WhatsApp Web との連携と API エンドポイントを処理します

📋 必要なシークレット

セキュリティを強化するため、両方のサーバーで環境変数の代わりにファイルベースのシークレットを使用します。各シークレットは secrets/ フォルダー内の個別のファイルに保存されます。

MCP サーバー（mcp_server/secrets/）

• CHATTERBOX_SECRET - WhatsApp サーバーへの API 呼び出しに使用する認証シークレット
• WHATSAPP_SERVER_URL - WhatsApp サーバーの URL（例：http://localhost）
• SERVER_PORT - サーバーがリッスンするポート（例：3004）

WhatsApp サーバー（whatsappServer/secrets/）

• CHATTERBOX_SECRET - 認証シークレット（MCP サーバーのシークレットと一致させる必要があります）
• PORT - サーバーのポート番号（例：3004）
• HEADLESS - WhatsApp をヘッドレスモードで実行するかどうか（true または false）

注： 認証を機能させるには、両方のサーバーで CHATTERBOX_SECRET を同じ値にする必要があります。

🐳 Docker

各コンポーネントには、コンテナ化用の独自の Dockerfile があります。

# WhatsApp Server
cd whatsappServer
docker build -t whatsapp-server .

# MCP Server
cd mcp_server
docker build -t mcp-server .