Ycloud Whatsapp MCP Server

🚀 YCloud WhatsApp API MCP Server

This is a YCloud WhatsApp API server built on the Model Context Protocol (MCP). It can automatically generate tools from the YCloud WhatsApp OpenAPI specification, enabling AI models (such as Claude) to directly interact with the YCloud WhatsApp API.

🚀 Quick Start

Prerequisites

Before using this server, you need to:

1. Register an account on the YCloud official website.
2. Obtain your API key (see the instructions below).
3. Install the necessary software dependencies (see the instructions below).

System Requirements

• Node.js v16.0.0 or higher.
• npm v7.0.0 or higher.
• Claude desktop application (if you want to integrate with Claude).

✨ Features

• Automatically generate MCP tools from the OpenAPI specification.
• Support all YCloud API endpoints.
• Support API authentication.
• Automatically handle parameter types and validation.
• Support HTTP request and response handling.

📦 Installation

# Clone the repository
git clone https://github.com/YCloud-Developers/ycloud-whatsapp-mcp-server.git
cd ycloud-whatsapp-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

💻 Usage Examples

Obtain an API Key

To use the YCloud API, you need an API key for authentication:

1. Log in to the YCloud console.
2. Navigate to the developer page.
3. On this page, you can find your API key.

The API key should be included in all API requests as the request header X-API-Key.

Environment Variable Configuration

You can configure the server through the following environment variables:

• API_BASE_URL: The base URL of the YCloud API (default: https://api.ycloud.com/v2).
• OPENAPI_SPEC_PATH: The path or URL of the OpenAPI specification (default: https://docs.ycloud.com/openapi.json).
• API_HEADERS: API request headers (format: key1:value1,key2:value2).

Claude Desktop Integration

To use this server in the Claude desktop application, edit the Claude configuration file:

1. Find or create the Claude desktop configuration file:
   • On macOS: ~/Library/Application Support/Claude/claude_desktop_config.json.
   • On Windows: %APPDATA%\Claude\claude_desktop_config.json.
2. Add the following configuration:

{
  "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"
      }
    }
  }
}

3. Replace your-api-key-here with your YCloud API key.

Direct Run

# Set environment variables and run
API_BASE_URL=https://api.ycloud.com/v2 \
API_HEADERS="X-API-Key: your_api_key_here" \
node index.js

Example

Use the following prompt in Claude:

/YCloud API Balance Query my account balance.

🛠️ Debugging

• Use console.log() for debugging.
• Use process.env to view environment variables.
• Use express middleware to debug API requests and responses.

🤝 Contribution

Contributions are welcome! Please refer to the Contribution Guide.

📄 License

This project is licensed under the MIT License.