← 返回目录
O

OpenWA

社区
免费开源的 WhatsApp API 网关,支持作为 MCP 服务器供 AI 智能体使用
分类
开发工具 第 290 / 438
Stars
★ 15.3k 非常热门
传输方式
Streamable HTTP
运行环境
Docker · Node.js 22 LTS
凭据
需要 API Key / 凭据
许可证
MIT
最近提交
工具数
1
47FMRS · D

OpenWA 提供了一个轻量级的 MCP 服务器,用于将 WhatsApp 自动化能力安全地暴露给 AI 智能体,但需要开发者具备一定的部署和配置经验,并接受非官方 API 的风险。

最强项 · 文档质量 14/20 最弱项 · 可靠性 5/20

可靠性
5/20
安全与权限
10/20
维护活跃度
6/20
文档质量
14/20
安装易用性
12/20
查看各项评分依据
可靠性 5/20
证据有限:README 声称 MCP 默认关闭、可通过 MCP_ENABLED=true 挂载 POST /mcp 并提供 51 个精选工具与 API-key 认证;但未提供 server manifest、源码、测试或 CI 执行证据,工具清单无法与真实行为核对,错误处理和依赖故障不可诊断。扣分:静态评审要求可验证执行证据,缺失证据只能下调。
安全与权限 10/20
没有触发红线(无恶意代码、窃密、真实凭据或默认破坏性操作)。README 描述了不错的控制面:MCP 默认关闭、建议专用最小权限 key、OPERATOR/会话级作用域、MCP_READONLY、调用频率限制,并明确警告不要把 /mcp 暴露到公网;示例只用占位符。扣分:这些安全属性只是文档声明,源码未提供;危险操作的显式确认机制也未在材料中验证。
维护活跃度 6/20
证据显示仓库未归档、MIT 许可证、开放 issue 较少,README 提到 CI 与文档目录;这些都只是表面活跃信号。扣分:没有提交历史、发布版本、依赖更新节奏或安全响应渠道等可核实维护证据,无法确认持续维护与治理质量。
文档质量 14/20
README 本身分层较完整:安装、端口、API curl 示例、MCP 客户端 .mcp.json 示例、认证/只读/限流说明、WhatsApp 封号风险、安全架构和 docs 索引都有。扣分:没有列出 51 个 MCP 工具和参数 schema,docs 实际文件未提供,缺少费用/用量之外更细的成本与排障证据。
安装易用性 12/20
安装路径清楚:Docker Compose 一条命令、本地 npm ci 流程、生产 profiles、端口表、MCP 客户端配置示例以及多架构镜像。扣分:MCP 默认关闭且未展示 API key 创建步骤;WhatsApp 会话/QR 扫码流程没有可执行验证;按静态校准,缺少测试/CI 证据使该维度不能高于 15。

静态评测 · 未实际运行收录于 2026-08-07

查看 FMRS 评分方法 →

选型与风险

能访问什么访问网络修改第三方账户数据

适合谁

  • 开发者和技术爱好者,希望自托管 WhatsApp API 网关
  • 需要将 WhatsApp 自动化能力集成到 AI 智能体的场景
  • 个人项目或内部工具,需要低成本的消息自动化
  • 愿意接受非官方 API 风险和账户限制的开发者

不适合谁

  • 需要官方 WhatsApp Cloud API 保证合规的生产环境(如医疗、金融、大规模商业消息)
  • 无法接受账户封禁风险的用户
  • 希望零配置即可使用的用户(需要一定部署和配置)
  • 需要完整 REST API 覆盖的场景(MCP 只暴露精选工具)

所需权限

  • 需要 API 密钥认证(role 为 OPERATOR 或更低,session-scoped)
  • 可能需要访问 Docker 套接字(如果使用内置编排,但有 docker-proxy 保护)
  • MCP 端点需要可从客户端访问(如 localhost 或局域网)
  • 建议使用专用 WhatsApp 号码,避免主号风险

风险与副作用

  • 非官方 WhatsApp API,存在账户被限制或封禁的风险
  • 消息可能被 WhatsApp 服务器端丢弃(首次发送给新联系人)
  • 需要定期检查依赖更新,以应对 WhatsApp 协议变化
  • MCP 端点如果暴露到公网,可能被滥用(需前置认证代理)

安装接入

准备工作

运行环境:Docker · Node.js 22 LTS

MCP_ENABLED 必填 设为 true 才会在 POST /mcp 挂载 MCP 服务器,默认关闭。
其他可选配置项(4 个)
MCP_READONLY 可选 设为 true 时只挂载读取类工具,禁用发送/写入操作。
MCP_RATE_LIMIT_MAX 可选 每个 API key 每窗口允许的 MCP 工具调用次数,默认 60。
MCP_RATE_LIMIT_WINDOW_MS 可选 限速滑动窗口大小(毫秒),默认 60000。
ENGINE_TYPE 可选 选择 WhatsApp 引擎(whatsapp-web.js 或 baileys),在 .env 或 compose 中设置。
  1. 克隆仓库:git clone https://github.com/rmyndharis/OpenWA.git && cd OpenWA\n2. 启动 Docker 容器:docker compose -f docker-compose.dev.yml up -d(或使用生产部署命令)\n3. 设置 MCP_ENABLED=true 环境变量(可在 .env 或 docker-compose 中设置)\n4. 重启服务:npm run start:prod 或重启容器\n5. 配置 MCP 客户端(如 Claude Code 的 .mcp.json),指定 URL 为 http://localhost:2785/mcp,并在请求头中携带 API 密钥。
claude_desktop_config.json
{
  "mcpServers": {
    "openwa": {
      "type": "http",
      "url": "http://localhost:2785/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

以 Claude Desktop 为例。其他客户端的配置文件位置或字段可能不同(如 VS Code 使用 servers 字段),可用下方配置生成器转换。

.vscode/mcp.json
{
  "servers": {
    "openwa": {
      "type": "http",
      "url": "http://localhost:2785/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

写入项目的 .vscode/mcp.json(VS Code 使用 servers 字段)。

Terminal
claude mcp add --transport http openwa http://localhost:2785/mcp --header 'Authorization: Bearer YOUR_API_KEY'

在终端运行;先把 <…> 占位符换成你自己的值。

验证是否装好

在启用 MCP_ENABLED=true 并启动服务后,将 MCP 客户端指向 http://localhost:2785/mcp,工具列表中应出现 openwa 的会话/消息类工具;用只读工具(如列出会话或读取 webhook)成功返回即证明 API key 认证与连接正常。

常见排障

  1. 检查 MCP_ENABLED 是否已设置且服务已重启
  2. 确认 API 密钥是否有效,且有正确的角色和会话范围(不能带 IP 白名单)
  3. 检查网络连接,确保客户端能访问 /mcp 端点
  4. 查看服务日志,确认 MCP 是否成功挂载
  5. 验证请求头 Authorization 或 X-API-Key 是否正确

试试这样问

连接成功后,可以直接对 AI 助手这样说:

  • 列出当前 OpenWA 实例上所有的 WhatsApp 会话及其连接状态
  • 通过 openwa 会话给 [email protected] 发送一条文本消息
  • 读取会话中配置的所有 webhook 及其订阅的事件
  • 给我某个聊天加上标签并展示现有标签列表

工具能力 1

51 curated tools (sessions, messaging, contacts, basic group ops, webhook reads, labels, automation-rule reads)
提供会话管理、消息发送/接收、联系人管理、基础群组操作、Webhook 读取、标签管理、自动化规则读取等 51 个精选工具,供 AI 智能体调用。

使用场景

让 AI 智能体自动回复 WhatsApp 消息
通过 AI 助手发送定时消息或通知
自动化客户支持流程,AI 代理处理常见咨询
集成聊天机器人到 WhatsApp 群组

支持客户端

Claude Desktop
Cursor

依据项目文档列出,未经本站实测。

详细介绍

OpenWA 是一个免费、开源、可自托管的 WhatsApp API 网关,提供 REST API、Webhook、多会话管理、Web 仪表盘等功能。它支持通过配置切换数据库、存储和缓存后端,并可通过设置 MCP_ENABLED=true 启用 MCP 服务器,在现有服务上挂载 /mcp 端点,暴露 51 个精选工具(会话、消息、联系人、基础群组操作、Webhook 读取、标签、自动化规则读取),供 AI 智能体(如 Claude、Cursor)调用。MCP 服务器默认关闭,启用后所有 REST 路由保持不变。

同类可选方案

Context7 80 · B

Upstash 官方维护,为 AI 编码助手提供实时更新的第三方库文档

★ 62.9k · 工具数 2 与当前对比 →

源版本 8a45366a2877 数据同步于 2026-10-12 查看 FMRS 评分方法