YCloud WhatsApp API MCP 服务器

1# YCloud WhatsApp API MCP 服务器
2 
3[English](README-en.md) | 中文
4 
5这是一个基于[Model Context Protocol (MCP)](https://modelcontextprotocol.io/)构建的YCloud WhatsApp API服务器。它能够自动从YCloud WhatsApp OpenAPI规范中生成工具，让AI模型（如Claude）可以直接与YCloud WhatsApp API交互。
6 
7## 前提条件
8 
9在使用此服务器之前，您需要：
10 
111. 在 [YCloud官网](https://www.ycloud.com) 注册一个账户
122. 获取您的API密钥（请参阅下面的说明）
133. 安装必要的软件依赖（请参阅下面的说明）
14 
15## 系统要求
16 
17- Node.js v16.0.0 或更高版本
18- npm v7.0.0 或更高版本
19- Claude 桌面应用（如果要与 Claude 集成）
20 
21## 功能
22 
23- 自动从OpenAPI规范生成MCP工具
24- 支持所有YCloud API端点
25- 支持API认证
26- 自动处理参数类型和验证
27- 支持HTTP请求和响应处理
28 
29## 安装
30 
31```bash
32# 克隆仓库
33git clone https://github.com/YCloud-Developers/ycloud-whatsapp-mcp-server.git
34cd ycloud-whatsapp-mcp-server
35 
36# 安装依赖
37npm install
38 
39# 构建项目
40npm run build
41```
42 
43## 使用方法
44 
45### 获取API密钥
46 
47要使用YCloud API，您需要一个API密钥进行身份验证：
48 
491. 登录到 [YCloud控制台](https://www.ycloud.com/console/)
502. 导航到开发者页面
513. 在此页面上，您可以找到您的API密钥
52 
53API密钥应作为请求头 `X-API-Key` 包含在所有API请求中。
54 
55### 环境变量配置
56 
57您可以通过以下环境变量配置服务器：
58 
59- `API_BASE_URL`: YCloud API的基础URL（默认：https://api.ycloud.com/v2）
60- `OPENAPI_SPEC_PATH`: OpenAPI规范的路径或URL（默认：https://docs.ycloud.com/openapi.json）
61- `API_HEADERS`: API请求头（格式：key1:value1,key2:value2）
62 
63### Claude桌面端集成
64 
65要在Claude桌面应用中使用此服务器，请编辑Claude配置文件：
66 
671. 找到或创建Claude桌面配置文件：
68   - 在macOS上：`~/Library/Application Support/Claude/claude_desktop_config.json`
69   - 在Windows上：`%APPDATA%\Claude\claude_desktop_config.json`
70 
712. 添加以下配置：
72 
73```json
74{
75  "mcpServers": {
76    "ycloud-whatsapp": {
77      "command": "node",
78      "args": ["path/to/ycloud-whatsapp-mcp-server/build/index.js"],
79      "env": {
80        "API_BASE_URL": "https://api.ycloud.com/v2",
81        "API_HEADERS": "X-API-Key:your-api-key-here"
82      }
83    }
84  }
85}
86```
87 
883. 替换`your-api-key-here`为您的YCloud API密钥
89 
90### 直接运行
91 
92```bash
93# 设置环境变量并运行
94API_BASE_URL=https://api.ycloud.com/v2 \
95API_HEADERS="X-API-Key:your-api-key-here" \
96npm start
97```
98 
99## 示例
100 
101在Claude中，您可以使用以下提示来与YCloud API交互：
102 
103```
104请帮我查询我的YCloud账户余额。
105```
106 
107Claude将能够调用适当的API端点并返回结果。
108 
109## 调试
110 
111在开发过程中，您可以使用以下方法调试MCP服务器：
112 
1131. 查看服务器日志：服务器运行时会输出调试信息
1142. 使用MCP Inspector：您可以使用[MCP Inspector](https://modelcontextprotocol.io/inspector)工具来检查服务器的运行状态
1153. Claude桌面端调试：在Claude桌面应用中可以查看服务器状态和日志
116 
117## 贡献
118 
119欢迎提交Pull Request或创建Issue来改进此项目。
120 
121## 许可证
122 
123MIT