返回 MCP 目录
public公开dns本地运行

gallabox-mcp-server

Gallabox MCP服务器是一个用于与WhatsApp消息交互的API服务,支持发送文本、模板和交互式消息。

article

README

🚀 Gallabox MCP 服务器

Gallabox MCP(消息通信协议)服务器基于 Gallabox API 构建,可实现与 WhatsApp 进行消息交互的功能,为用户提供便捷的消息发送服务。

✨ 主要特性

本服务器提供了一系列工具,用于向 WhatsApp 发送不同类型的消息,具体如下:

  1. sendTextMessage

    • 功能:发送一条文本消息到 WhatsApp。
    • 所需输入
      • recipient(对象):收件人的信息,包含:
        • name(字符串):收件人姓名。
        • phone(字符串):收件人电话号码。
      • content(字符串):文本消息的内容。
    • 返回值:消息发送确认,包括 ID 和状态。
  2. sendTemplateMessage

    • 功能:发送一条模板消息到 WhatsApp。
    • 所需输入
      • recipient(对象):收件人的信息,包含:
        • name(字符串):收件人姓名。
        • phone(字符串):收件人电话号码。
      • templateName(字符串):要使用的模板名称。
      • templateValues(对象):模板中的占位符值。
    • 返回值:模板消息发送确认,包括 ID 和状态。
  3. sendInteractiveMessage

    • 功能:发送一条交互式消息到 WhatsApp。
    • 所需输入
      • recipient(对象):收件人的信息,包含:
        • name(字符串):收件人姓名。
        • phone(字符串):收件人电话号码。
      • content(字符串):交互式消息的内容。
      • buttons(数组):消息中的按钮数组,每个按钮对象必须包含:
        • type(字符串):应该是 "reply" 类型。
        • reply(对象):包含:
          • id(字符串):回复按钮的 ID。
          • title(字符串):回复按钮的标题。
    • 返回值:交互式消息发送确认,包括 ID 和状态。

📦 安装指南

  1. 克隆仓库
    使用以下命令将此仓库克隆到本地机器:

    git clone https://github.com/yourusername/gallabox-mcp-server.git
    
  2. 安装依赖项
    切换到项目目录并安装所需依赖项:

    cd gallabox-mcp-server
    yarn
    

📚 详细文档

Claude Desktop 配置

要在 Claude Desktop 上运行 Gallabox MCP 服务器,需要配置 claude_desktop_config.json 文件。以下是示例配置:

{
    "mcpServers": {
        "whatsapp": {
            "command": "npx",
            "args": ["-y", "/Users/navayuvan/Works/gallabox-mcp-server"],
            "env": {
                "CHANNEL_ID": "<your_channel_id>",
                "GALLABOX_API_KEY": "<your_api_key>",
                "GALLABOX_API_SECRET": "<your_api_secret>"
            }
        }
    }
}

配置完成后重启 Claude Desktop。

配置说明

  • command:执行服务器的命令,使用 npx 来运行本地包。
  • args:传递给命令的参数,指定 Gallabox MCP 服务器路径。
  • env:服务器运行所需的环境变量,包括 API 凭证和通道 ID。
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端