Skip to main content
Glama
Sign In
YCloud WhatsApp API MCP Server

YCloud WhatsApp API MCP Server

by YCloud-Developers
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

YCloud WhatsApp API MCP 服务器

English | 中文

这是一个基于Model Context Protocol (MCP)构建的YCloud WhatsApp API服务器。它能够自动从YCloud WhatsApp OpenAPI规范中生成工具，让AI模型（如Claude）可以直接与YCloud WhatsApp API交互。

前提条件

在使用此服务器之前，您需要：

  1. 在 YCloud官网 注册一个账户

  2. 获取您的API密钥（请参阅下面的说明）

  3. 安装必要的软件依赖（请参阅下面的说明）

Related MCP server: WhatsApp MCP Server

系统要求

  • Node.js v16.0.0 或更高版本

  • npm v7.0.0 或更高版本

  • Claude 桌面应用（如果要与 Claude 集成）

功能

  • 自动从OpenAPI规范生成MCP工具

  • 支持所有YCloud API端点

  • 支持API认证

  • 自动处理参数类型和验证

  • 支持HTTP请求和响应处理

安装

# 克隆仓库
git clone https://github.com/YCloud-Developers/ycloud-whatsapp-mcp-server.git
cd ycloud-whatsapp-mcp-server

# 安装依赖
npm install

# 构建项目
npm run build

使用方法

获取API密钥

要使用YCloud API，您需要一个API密钥进行身份验证：

  1. 登录到 YCloud控制台

  2. 导航到开发者页面

  3. 在此页面上，您可以找到您的API密钥

API密钥应作为请求头 X-API-Key 包含在所有API请求中。

环境变量配置

您可以通过以下环境变量配置服务器：

Claude桌面端集成

要在Claude桌面应用中使用此服务器，请编辑Claude配置文件：

  1. 找到或创建Claude桌面配置文件：

    • 在macOS上：~/Library/Application Support/Claude/claude_desktop_config.json

    • 在Windows上：%APPDATA%\Claude\claude_desktop_config.json

  2. 添加以下配置：

{
  "mcpServers": {
    "ycloud-whatsapp": {
      "command": "node",
      "args": ["path/to/ycloud-whatsapp-mcp-server/build/index.js"],
      "env": {
        "API_BASE_URL": "https://api.ycloud.com/v2",
        "API_HEADERS": "X-API-Key:your-api-key-here"
      }
    }
  }
}

  1. 替换your-api-key-here为您的YCloud API密钥

直接运行

# 设置环境变量并运行
API_BASE_URL=https://api.ycloud.com/v2 \
API_HEADERS="X-API-Key:your-api-key-here" \
npm start

示例

在Claude中，您可以使用以下提示来与YCloud API交互：

请帮我查询我的YCloud账户余额。

Claude将能够调用适当的API端点并返回结果。

调试

在开发过程中，您可以使用以下方法调试MCP服务器：

  1. 查看服务器日志：服务器运行时会输出调试信息

  2. 使用MCP Inspector：您可以使用MCP Inspector工具来检查服务器的运行状态

  3. Claude桌面端调试：在Claude桌面应用中可以查看服务器状态和日志

贡献

欢迎提交Pull Request或创建Issue来改进此项目。

许可证

MIT

Available Tools

19 tools
wa_business_listB

List WABAs

Inputs: no named parameters.

wa_business_retrieveC

Retrieve a WABA

Inputs: id (required).

wa_inbound_markC

Mark message as read

Inputs: id (required).

wa_msg_retrieveC

Retrieve a message

Inputs: no named parameters.

wa_msg_sendD

Enqueue a message

Inputs: body.

wa_msg_send_directlyD

Send a message directly

Inputs: body.

wa_phone_listB

List phone numbers

Inputs: no named parameters.

wa_phone_registerC

Register a phone number

Inputs: wabaId (required), phoneNumber (required).

wa_phone_retrieveD

Retrieve a phone number

Inputs: wabaId (required), phoneNumber (required).

wa_phone_retrieve_commerce_settingsD

Retrieve commerce settings

Inputs: wabaId (required), phoneNumber (required).

wa_phone_retrieve_profileC

Retrieve a phone number profile

Inputs: wabaId (required), phoneNumber (required).

wa_phone_update_commerce_settingsD

Update commerce settings

Inputs: wabaId (required), phoneNumber (required), body.

wa_phone_update_profileC

Update a phone number profile

Inputs: wabaId (required), phoneNumber (required), body.

wa_template_createD

Create a template

Inputs: body.

wa_template_deleteC

Delete a template

Inputs: name (required), language (required).

wa_template_delete_by_nameC

Delete templates by name

Inputs: name (required).

wa_template_editD

Edit a template

Inputs: name (required), language (required), body.

wa_template_getC

Retrieve a template

Inputs: name (required), language (required).

wa_template_listC

List templates

Inputs: filter.name (required), filter.language (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Deploy Server
    Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

    TDQS

    C2.8/5.0

    Scored across 19 tools

    Disambiguation4/5

    Most tools have distinct purposes targeting specific WhatsApp API resources (WABAs, messages, phones, templates) with clear action verbs. However, wa_msg_send and wa_msg_send_directly could cause confusion as they both send messages with only a delivery timing distinction that might not be immediately clear from the names alone.

    Naming Consistency5/5

    All tool names follow a consistent snake_case pattern with a clear wa_resource_action structure (e.g., wa_business_list, wa_msg_send, wa_template_create). The naming convention is predictable and uniform across all 19 tools, making them easily parsable.

    Tool Count4/5

    With 19 tools, the count is slightly high but reasonable for a comprehensive WhatsApp API server covering multiple resource types (businesses, messages, phones, templates). It provides detailed operations without being overwhelmingly large, though it borders on the heavy side.

    Completeness5/5

    The tool set offers complete CRUD/lifecycle coverage for all key WhatsApp API domains: WABAs (list/retrieve), messages (send/retrieve/mark read), phone numbers (list/register/retrieve/update settings and profile), and templates (create/edit/get/list/delete). No obvious gaps exist for typical agent workflows.

    Maintenance

    ActivityInactive
    ResponsivenessOutdated data

    Resources

    Related MCP Connectors

    Related MCP Servers

    • WhatsApp MCP Server

      msaelices
      A
      license
      B
      quality
      D
      maintenance
      A Python server that enables language models like Claude to interact with WhatsApp Business API through GreenAPI, supporting features like sending messages and managing groups.
      5
      27
      MIT

    • WhatsApp MCP Server

      jlucaso1
      A
      license
      C
      quality
      D
      maintenance
      A Model Context Protocol server that connects your personal WhatsApp account to AI agents like Claude, enabling them to search messages, view contacts, retrieve chat history, and send messages via WhatsApp.
      7
      16 npm
      75
      ISC

    • mcp-whatsapp-claude

      PedroSodrr10
      A
      license
      Not graded
      quality
      D
      maintenance
      A local MCP server that connects WhatsApp to Claude via QR code, enabling chat listing, message retrieval, and sending with automatic rate limiting for anti-ban protection.
      45 npm
      MIT

    Appeared in Searches