MCP Evolution API
用于与 WhatsApp Evolution API 集成的 MCP(Model Context Protocol)服务器。
📋 概述
该 MCP 服务器允许 Claude 通过 Evolution API 与 WhatsApp 进行交互,支持以下功能:
- 管理 WhatsApp 实例
- 发送文本消息
- 获取连接用的 QR 码
- 检查实例状态
🚀 快速配置
环境配置
创建一个
.env
文件,并填入您的 Evolution API 凭证:系统要求
- Node.js 18 或更高版本
- NPM 或 Yarn
- 已安装并运行的 Evolution API(请参阅官方文档)
📋 部署选项
环境 | 步骤 | 命令 |
本地开发 | 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 --name mcp-evolution-api generaai/mcp-evolution-api:latest |
Claude Desktop 配置
将此内容添加到您的 Claude Desktop 配置文件(通常位于 Windows 的
%APPDATA%/Claude/claude_desktop_config.json
中):或者,如果您在本地运行:
🔧 可用工具
MCP 服务器向 Claude 提供以下工具:
- createEvolutionInstance: 创建新的 WhatsApp 实例
- listEvolutionInstances: 列出所有可用实例
- getWhatsAppQrCode: 获取实例的连接 QR 码
- sendWhatsAppMessage: 向联系人发送文本消息
🧪 使用示例
创建新实例
发送消息
📚 文档
📄 许可证
本项目遵循 MIT 许可证 - 详情请参阅 LICENSE 文件。
👨💻 致谢
使用 Docker 部署
1. 环境配置
在项目根目录下创建一个
.env
文件,并填入以下变量:2. 构建与运行
以生产模式启动服务器:
该命令将:
- 构建 Docker 镜像
- 以 detached 模式(后台)启动容器
- 将端口 3000 映射到 MCP 服务器
3. 查看日志
要查看应用程序日志:
4. 停止服务器
要停止服务器:
与 Docker 中的 Evolution API 集成
docker-compose.yml
文件中包含了一个注释掉的配置,用于将 Evolution API 与 MCP 服务器一起运行。要启用此集成:- 编辑
docker-compose.yml
文件,取消注释与 Evolution API 相关的部分
- 根据需要调整环境变量
- 运行命令
docker-compose up -d
这将分别启动 MCP 服务器和 Evolution API,但它们在同一个 Docker 网络中,允许彼此通信。
在此场景下,请将
.env
文件中的 EVOLUTION_API_URL
变量配置为 http://evolution-api:8080/
。使用 MCP 服务器
服务器将在
http://localhost:3000
上可用,提供以下端点:/mcp/tools
- 列出所有可用工具
/mcp/run
- 执行特定工具
维护
更新
要使用新更改更新应用程序:
备份
持久化数据存储在
mcp-data
卷中。要进行备份:- Author:waytomcp
- URL:https://www.waytomcp.com/article/genera-ai/mcp-evolution-api
- Copyright:All articles in this blog, except for special statements, adopt BY-NC-SA agreement. Please indicate the source!