AI导哈

WhatsApp商业API集成服务

一个生产就绪的Node.js MCP服务器，提供Claude与WhatsApp商业云API之间的无缝集成，适用于企业通讯、客户互动和自动化消息处理。

  • by prakashwagle
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 prakashwagle/mcp-whatsapp-business-api

使用说明

WhatsApp业务API MCP集成

一个可用于生产的Node.js模型上下文协议（MCP）服务器，提供Claude和WhatsApp Business Cloud API之间的无缝集成。

特性

🏢 业务概况管理

  • 查看和更新业务简介信息
  • 通过浏览个人资料详细信息 whatsapp://business_profile

📱 电话号码管理

  • 列出所有已注册的电话号码
  • 获取详细的电话号码信息
  • 通过浏览电话号码 whatsapp://phone_numbers
  • 请求验证码

💬 消息传递

  • 发送文本、模板和媒体消息
  • 通过以下方式列出和浏览消息模板 whatsapp://templates
  • 将邮件标记为已读
  • 支持图像、音频、文档、视频和贴纸

🔐 注册与验证

  • 注册和注销电话号码
  • 电话号码验证
  • 两步验证管理
  • 检查注册状态

📊 分析和监控

  • 实时WhatsApp事件流
  • 消息传递分析
  • 会话成本跟踪
  • 模板性能指标
  • 通过浏览分析 whatsapp://analytics/*

🗄️ 数据库集成 （可选）

  • PostgreSQL对数据持久性的支持
  • 通过资源浏览数据库表和模式

🛠️ 开发者体验

  • 双传输模式：STDIO（适用于Claude Desktop）和SSE（适用于web客户端）
  • 实时webhook处理和事件广播
  • 全面的错误处理，提供详细的WhatsApp API错误信息
  • 常见任务的预构建提示
  • 具有严格类型检查的TypeScript
  • Docker容器化
  • 带有GitHub操作的CI/CD管道

快速开始

  1. 克隆并安装：

    git clone https://github.com/prakashwagle/mcp-whatsapp-business-api.git
cd mcp-whatsapp-business-api
npm install

  2. 配置环境：

    cp .env.example .env
# Edit .env with your WhatsApp API credentials

  3. 启动开发服务器：

    npm run dev

  4. 与Claude整合：

    npm run build
npm install -g .
claude --mcp="mcp-whatsapp-business-api"

📖 完整安装指南

有关详细的设置说明，包括：

  • WhatsApp Business API凭据设置
  • 生产部署选项
  • 安全最佳实践
  • MCP与Claude Desktop的集成
  • 故障排除指南

👉 请参阅SETUP.md

建筑

工具与资源

该项目遵循最佳MCP模式：

  • 🔧 工具 -用于参数化操作和实时操作

    • whatsapp_send_text_message
    • whatsapp_get_phone_numbers
    • whatsapp_update_business_profile

  • 📋 资源 -用于可浏览数据发现

    • whatsapp://business_profile
    • whatsapp://phone_numbers
    • whatsapp://templates

内置提示

  • help_with_business_profile -业务概况管理指南
  • help_with_messaging -文本、模板和媒体消息帮助
  • help_with_registration -电话注册和验证
  • help_with_two_step_verification -安全设置指南
  • help_with_whatsapp_api -API功能概述

发展

# Development server
npm run dev

# Build
npm run build

# Lint and format
npm run lint
npm run format

# Production server
npm start

生产部署

支持多种部署选项：

  • AWS SSM参数存储 （推荐）
  • 带有环境变量的Docker
  • Docker Swarm的秘密
  • AWS机密管理器

看 设置.md 了解详细的部署说明。

需求

  • Node.js 18+
  • WhatsApp Business API帐户
  • Facebook/Meta开发者帐户
  • WhatsApp Business的注册电话号码

贡献

  1. 分叉存储库
  2. 创建要素分支
  3. 进行更改
  4. 运行测试和梳理： npm test && npm run lint
  5. 提交拉取请求

许可证

MIT许可证-请参阅 许可证 了解详情。

支持

相关 MCP