MCP Evolution API

MCP Evolution API

用于与 WhatsApp 的 Evolution API 集成的 MCP（Model Context Protocol）服务。

📋 概述

此 MCP 服务允许大语言模型通过 Evolution API 与 WhatsApp 交互，并启用以下功能：

• 管理 WhatsApp 实例
• 发送文本消息
• 获取用于连接的 QR Code
• 检查实例状态

🚀 快速配置

要求

• Node.js 18 或更高版本
• NPM 或 Yarn
• 可访问 Evolution API 安装实例（URL 和 API 密钥）

环境配置

创建一个 .env 文件，填入 Evolution API 凭据：

# 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 Key 身份验证来保护端点。要验证请求，请添加 X-API-Key 标头，其值为环境变量 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 code
• 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]