MCP Evolution API

MCP Evolution API

site icon
2025.03.24 9
TypeScriptWhatsApp自动化消息服务群组管理交流协作
MCP Evolution API 是一个基于 Model Context Protocol (MCP) 的服务,用于与 WhatsApp 的 Evolution API 集成,实现 WhatsApp 自动化功能。该服务允许 Claude 通过 Evolution API 与 WhatsApp 交互,支持管理 WhatsApp 实例、发送消息、处理联系人和群组、配置 webhook 和设置等功能。
View on GitHub

Overview

基本能力

产品定位

MCP Evolution API 是一个用于 WhatsApp 自动化的中间件服务,通过集成 Evolution API 提供丰富的 WhatsApp 操作能力。

核心功能

  • WhatsApp 实例管理:创建、获取、连接、重启、登出和删除 WhatsApp 实例
  • 消息发送:支持文本、状态、媒体、音频、贴纸、位置、联系人、反应、投票、列表和按钮等多种消息类型
  • 联系人和群组管理:查找联系人、聊天记录和群组成员
  • Webhook 和设置:配置和查找 webhook 及设置
  • 状态管理:设置在线状态

适用场景

  • 企业客服自动化
  • 营销消息推送
  • 群组管理自动化
  • WhatsApp 机器人开发
  • 工作流程自动化

工具列表

  • Evolution API 客户端:用于与 Evolution API 交互
  • MCP 工具实现:提供 WhatsApp 自动化功能的工具集
  • 共享工具:包括类型定义和实用函数

常见问题解答

  • 需要有效的 Evolution API 凭证才能使用
  • 部分群组管理功能尚未实现
  • 个人资料设置相关功能仍在开发中

使用教程

使用依赖

  1. 安装 Node.js 和 bun 运行时
  2. 克隆项目仓库

安装教程

本地开发

git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun install
bun run dev

本地生产环境

git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun install
bun run build && bun run dist/main.js

Docker Compose

git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api
docker-compose up -d

Docker

docker run -d -p 3000:3000 -e EVOLUTION_API_URL=yoururl -e EVOLUTION_API_KEY=yourkey --name mcp-evo-api ghcr.io/aiteks-ltda/mcp-evo-api:latest

调试方式

  1. 检查服务是否运行在指定端口
  2. 验证 Evolution API 连接
  3. 测试基本 WhatsApp 操作功能

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。