MCP Evolution API

MCP Evolution API

WhatsApp の Evolution API と統合するための MCP（Model Context Protocol）サーバーです。

📋 概要

この MCP サーバーを使用すると、言語モデルが Evolution API を介して WhatsApp と連携し、次の機能を利用できます。

• WhatsApp インスタンスの管理
• テキストメッセージの送信
• 接続用 QR コードの取得
• インスタンスのステータス確認

🚀 クイック設定

要件

• Node.js 18 以降
• NPM または Yarn
• Evolution API のインストール環境へのアクセス（URL と API キー）

環境設定

Evolution API の認証情報を記載した .env ファイルを作成します。

# Evolution API
EVOLUTION_API_URL=https://sua-evolution-api.com/
EVOLUTION_API_KEY=sua_chave_da_evolution_api
PORT=3000

# Autenticação
API_KEY=sua_chave_api_para_acesso

📋 デプロイオプション

環境	手順	コマンド
ローカル開発	1. クローンしてインストール 2. 開発モードで実行	git clone https://github.com/genera-ai/mcp-evolution-api.git && cd mcp-evolution-api && npm install && npm run dev
ローカル本番環境	1. クローンしてインストール 2. ビルドして実行	git clone https://github.com/genera-ai/mcp-evolution-api.git && cd mcp-evolution-api && npm install && npm run build && npm start
Docker	Docker コンテナを実行	docker run -d -p 3000:3000 -e EVOLUTION_API_URL=seuurl -e EVOLUTION_API_KEY=suachave -e API_KEY=suaapikey --name mcp-evolution-api generaai/mcp-evolution-api:latest

🔒 認証

このシステムでは、エンドポイントを保護するために API キー認証を使用します。リクエストを認証するには、環境変数 API_KEY に設定したキーを X-API-Key ヘッダーに追加します。

curl -X GET http://localhost:3000/tools \
  -H "X-API-Key: sua_chave_api"

API のすべてのルート（/initialize を除く）は保護されており、X-API-Key ヘッダーによる認証が必要です。

🔧 利用可能なツール

MCP サーバーは次のツールを公開します。

• createEvolutionInstance：新しい WhatsApp インスタンスを作成します
• listEvolutionInstances：利用可能なすべてのインスタンスを一覧表示します
• getWhatsAppQrCode：インスタンス接続用の QR コードを取得します
• sendWhatsAppMessage：連絡先にテキストメッセージを送信します

🧪 使用例

利用可能なツールを一覧表示する

curl -X GET http://localhost:3000/tools \
  -H "X-API-Key: sua_chave_api"

ツールを実行する（インスタンスの一覧表示）

curl -X POST http://localhost:3000/tools/listEvolutionInstances \
  -H "X-API-Key: sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{}'

🐳 Docker でデプロイする

1. 環境変数を使用する

docker run -d -p 3000:3000 \
  -e EVOLUTION_API_URL=https://sua-evolution-api.com/ \
  -e EVOLUTION_API_KEY=sua_chave_da_evolution_api \
  -e API_KEY=sua_chave_api \
  --name mcp-evolution-api generaai/mcp-evolution-api:latest

2. --env-file で .env ファイルを使用する

.env.docker ファイルを作成して実行します。

docker run -d -p 3000:3000 \
  --env-file .env.docker \
  --name mcp-evolution-api generaai/mcp-evolution-api:latest

3. Docker Compose を使用する

docker-compose.yml ファイルを作成します。

version: '3'

services:
  mcp-evolution-api:
    build: .
    ports:
      - "3000:3000"
    environment:
      - EVOLUTION_API_URL=https://sua-evolution-api.com/
      - EVOLUTION_API_KEY=sua_chave_da_evolution_api
      - PORT=3000
      - API_KEY=sua_chave_api

次のコマンドを実行します。

docker-compose up -d

📄 ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。詳細は LICENSE ファイルをご覧ください。

👨‍💻 クレジット

Generaai が開発
作者：Rubens U M Mendonça
メール：[email protected]