Evolution API

MCP演进API

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

📋 概览

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

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

🚀 快速设置

要求

• Node.js 18或更高级
• NPM纱线
• 访问 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

📋 部署选项

🔒 认证

该系统使用 API 密钥身份验证来保护端点。要验证您的请求，请添加标题 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 实例
• list进化实例列出所有可用实例
• 获取WhatsAppQrCode： 获取实例连接的 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 '{}'

🐳 部署com 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 文件 --env-file

创建文件 .env.docker e执行：

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

3.Usando Docker作曲

创建文件 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

E执行：

docker-compose up -d

📄 许可证

这个项目是根据麻省理工学院许可证授权的 - 详情请参阅许可证文件。

👨‍💻 学分

开发者 世代\ 作者 ： Rubens U M Mendonça\ 电子邮件：suporte@generaai.com.br