YCloud WhatsApp API
The YCloud WhatsApp API MCP server acts as a powerful bridge that allows AI assistants, such as Claude, to communicate directly through WhatsApp. In simple terms, it gives an AI the ability to send messages, manage conversations, and check account details just as a human would, but with the speed …
About this Protocol
How to Use
1. Installation
Prerequisites:
* Node.js v16.0.0 or higher
* npm v7.0.0 or higher
Steps:
1. Clone the repository:
bash
git clone https://github.com/YCloud-Developers/ycloud-whatsapp-mcp-server.git
cd ycloud-whatsapp-mcp-server
2. Install dependencies:
bash
npm install
3. Build the project:
bash
npm run build
2. Configuration
To use this server with Claude Desktop, you need a YCloud API Key from the YCloud Console.
Claude Desktop Configuration:
Add the following to your claude_desktop_config.json (located at ~/Library/Application Support/Claude/ on macOS or %APPDATA%\Claude\ on Windows):
{
"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"
}
}
}
}
Note: Replace path/to/ycloud-whatsapp-mcp-server with the actual path to the cloned repository and your-api-key-here with your real API key.
Environment Variables:
- API_BASE_URL: YCloud API base URL (Default: https://api.ycloud.com/v2)
- OPENAPI_SPEC_PATH: Path or URL to OpenAPI spec (Default: https://docs.ycloud.com/openapi.json)
- API_HEADERS: API request headers in key1:value1,key2:value2 format.
3. Available Tools
This MCP server automatically generates tools from the YCloud WhatsApp OpenAPI specification. Key features include:
* Message Management: Sending and managing WhatsApp messages.
* Account Access: Support for all YCloud API endpoints, including account balance queries.
* Dynamic Support: Automatically handles parameter types, validation, and HTTP requests/responses for all available API tools.
4. Example Prompts
You can use the following prompt to interact with the server via Claude:
- "Please help me check my YCloud account balance." (请帮我查询我的YCloud账户余额。)
- "Help me send a WhatsApp message using the YCloud API."
Use Cases
Use Case 1: Automated Customer Support and FAQ Handling
Problem: Customer support teams are often overwhelmed by repetitive questions regarding order status, store hours, or service availability, leading to slow response times and customer frustration.
Solution: By integrating the YCloud WhatsApp API MCP with an AI model like Claude, businesses can create a smart support agent. The AI can understand the customer's intent, retrieve necessary data (like order status from a database), and use the MCP server to send a personalized, immediate response via WhatsApp.
Example: A customer sends a WhatsApp message asking, "Where is my package?" Claude receives the query, looks up the tracking number in the company’s internal database, and then calls the YCloud MCP to send a message: "Hi Sarah! Your order #12345 is currently in transit and is expected to arrive by 3 PM tomorrow."
Use Case 2: Smart Appointment Reminders and Confirmations
Problem: Service-based businesses (clinics, salons, consultancies) lose significant revenue due to "no-shows." Manual phone calls or standard SMS reminders are often ignored or time-consuming for staff to manage.
Solution: An AI agent can monitor a booking calendar and use the YCloud MCP to send automated WhatsApp reminders. Because WhatsApp supports interactive elements, the AI can process the user's reply (e.g., "Confirm" or "Reschedule") and update the business system accordingly.
Example: Twenty-four hours before an appointment, Claude triggers the MCP to send a WhatsApp message: "Hi John, confirming your dental appointment tomorrow at 10 AM. Reply '1' to confirm or '2' to reschedule." If the user replies '2', Claude can suggest new time slots via the same thread.
Use Case 3: Real-time Operational Alerts and Account Management
Problem: Developers and business owners need to monitor their communication infrastructure (like API credit balances or system health) to prevent service interruptions, but they don't always have the time to check a dashboard.
Solution: This MCP allows an AI assistant to proactively monitor YCloud account status. The user can simply ask the AI for a status update, or the AI can be scripted to send an alert via WhatsApp if the account balance falls below a certain threshold.
Example: A developer asks Claude, "What's my current YCloud usage?" Claude calls the account balance endpoint through the MCP and responds: "You have $15.50 remaining. Based on your current volume, this will last approximately 4 days. Would you like me to send you the link to the top-up page?"
Use Case 4: Personalized Marketing and Lead Nurturing
Problem: Generic email marketing has low open rates. Businesses struggle to engage leads in a way that feels personal and timely without hiring a large sales team.
Solution: Using the YCloud MCP, an AI can send highly personalized outreach messages based on a user's previous interactions. Because the AI can handle the "management" of messages, it can also categorize responses from leads and flag high-priority conversations for human follow-up.
Example: When a user downloads a whitepaper from a website, Claude uses the MCP to send a WhatsApp message: "Hi Mike, I saw you were interested in our latest report on AI. I’m here if you have any questions about Page 5! Would you like to see a quick demo video?"
Use Case 5: Secure Transactional Notifications (OTP and Alerts)
Problem: Sending One-Time Passwords (OTPs) or sensitive transaction alerts via standard SMS can be unreliable in certain regions and lacks the "official" branding that builds user trust.
Solution: Businesses can use the YCloud MCP to send secure, branded transactional messages via WhatsApp. This ensures higher delivery rates and provides a professional appearance with a verified business profile.
Example: A user attempts to log in to a banking app. The app's backend triggers an AI workflow that uses the YCloud MCP to send a WhatsApp message: "Your verification code for SecureBank is 882-901. This code expires in 5 minutes. Do not share it with anyone."
