mcpField
P
Peach Whatsapp Business Api Mcp

Peach Whatsapp Business Api Mcp

本地服务
github.com/trypeach-io通信协作024 周前更新

关于 Peach Whatsapp Business Api Mcp

Peach 的 MCP 服务将 AI 助手连接到 Peach WhatsApp 消息平台,支持消息操作以及模板、联系人、媒体和广播管理。

主要功能

  1. 01发送模板消息和应用发起的消息
  2. 02将联系人连接到 AI Agent
  3. 03创建并管理广播
  4. 04创建、更新和提交模板
  5. 05创建和更新联系人
  6. 06列出、上传和删除媒体

适用场景

  1. 01向联系人发送 WhatsApp 模板消息
  2. 02发起广播活动
  3. 03提交模板供 Meta 审核
  4. 04更新联系人信息

MCP 相关

向 MCP 客户端提供 Peach WhatsApp 消息工具,包括发送消息以及管理模板、联系人、媒体和广播。可使用托管服务,也可在本地配置。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"trypeach-io": {
"command": "npx",
"args": [
"-y",
"@peachai/mcp"
]
}
}
}
启动命令npx -y @peachai/mcp

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
npm@peachai/mcp0.1.3

工具

20

收录的工具列表 · 更新于 2 周前

参数类型必填说明
contactobject是收件人联系人。必须提供 phone_number。
contact.namestring否联系人的全名
contact.emailstring否联系人的电子邮件地址
contact.metadataobject否自定义元数据键值对
contact.phone_numberstring是E.164 格式的电话号码(例如 +14155552671)
template_messageobject是模板消息参数
template_message.liquid_valuesobject否模板占位符的变量值
template_message.business_phone_numberstring否要使用的发送方电话号码的 WA ID
template_message.whats_app_template_idstring是要使用的 WhatsApp 模板 ID

详细介绍

@peachai/mcp

面向 Peach WhatsApp 消息平台的 MCP(Model Context Protocol)服务。让 Claude 等 AI 助手直接通过你的 Peach 账户发送消息、管理模板、联系人和媒体。

要求

  • Node.js 18 或更高版本
  • Peach 账户和 API 密钥

获取 API 密钥

登录 app.trypeach.ai,前往 Settings → API,然后复制你的 API 密钥。

设置

托管服务设置

推荐 Peach 提供托管 MCP 服务。我们建议使用此服务。

{
  "mcpServers": {
    "peach": {
      "url": "https://app.trypeach.ai/api/mcp",
      "headers": {
        "Authorization": "<YOUR PEACH API KEY>"
      }
    }
  }
}
Claude Desktop

将以下内容添加到你的 claude_desktop_config.json:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "peach": {
      "command": "npx",
      "args": ["-y", "@peachai/mcp"],
      "env": {
        "PEACH_API_KEY": "your-api-key"
      }
    }
  }
}

重启 Claude Desktop。你应该会在对话中看到可用的 Peach 工具。

Cursor

前往 Settings → MCP 并添加:

{
  "peach": {
    "command": "npx",
    "args": ["-y", "@peachai/mcp"],
    "env": {
      "PEACH_API_KEY": "your-api-key"
    }
  }
}
Claude Code

运行此命令,将 Peach AI 添加到你的 Claude Code 设置中:

claude mcp add --scope user --env PEACH_API_KEY=your-api-key peach -- npx -y @peachai/mcp

或者手动将其添加到你的 .mcp.json:

{
  "mcpServers": {
    "peach": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@peachai/mcp"],
      "env": {
        "PEACH_API_KEY": "your-api-key"
      }
    }
  }
}
Antigravity

前往 Antigravity 设置 -> Customizations。点击 Open MCP Config 并添加以下内容:

{
  "mcpServers": {
    "peach": {
      "serverUrl": "https://app.trypeach.ai/api/mcp",
       "headers": {
        "Authorization": "<YOUR PEACH API KEY>"
      }
    }
  }
}

可用工具

消息发送
工具说明
peach_send_template_message向联系人发送 WhatsApp 模板消息
peach_send_app_message触发流程或由应用发起的消息
peach_connect_to_ai_agent发送模板并将联系人连接到 AI Agent
peach_get_event_status检查已发送事件的状态
peach_list_template_messages按筛选条件列出已发送的模板消息
群发
工具说明
peach_launch_broadcast创建并启动群发活动
模板
工具说明
peach_list_templates列出所有 WhatsApp 模板
peach_get_template按 ID 或名称获取指定模板
peach_create_template创建新的 WhatsApp 模板
peach_update_template更新现有模板
peach_submit_template提交模板以供 Meta 审核
peach_pause_template暂停已批准的模板
peach_archive_template归档模板
联系人
工具说明
peach_create_contact创建或写入单个联系人
peach_create_contacts批量创建或写入联系人
peach_update_contact按电话号码更新联系人
媒体
工具说明
peach_list_media列出已上传的媒体文件
peach_upload_media上传媒体文件(base64)
peach_delete_media删除媒体文件
消息
工具说明
peach_list_messages按可选筛选条件列出消息

示例提示词

  • "向 +14155552671 发送 order_confirmation 模板,订单 ID 为 12345"
  • "创建一个名为 summer_sale 的新 MARKETING 模板,正文写着“本周末享受 8 折优惠!”"
  • "列出我所有已批准的 WhatsApp 模板"
  • "将联系人 +14155552671 的姓名更新为 John Smith"
  • "使用模板 promo_v2 向受众列表 abc123 发起群发"

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。