YCloud WhatsApp API

Interactúa con la API de YCloud WhatsApp para enviar y gestionar mensajes.

Documentación

Servidor MCP de YCloud WhatsApp API

Este es un servidor de YCloud WhatsApp API construido sobre Model Context Protocol (MCP). Genera automáticamente herramientas a partir de la especificación OpenAPI de YCloud WhatsApp, permitiendo que los modelos de IA (como Claude) interactúen directamente con la API de YCloud WhatsApp.

Requisitos previos

Antes de usar este servidor, necesita:

Registrar una cuenta en el sitio web oficial de YCloud
Obtener su clave de API (consulte las instrucciones a continuación)
Instalar las dependencias de software necesarias (consulte las instrucciones a continuación)

Requisitos del sistema

Node.js v16.0.0 o superior
npm v7.0.0 o superior
Aplicación de escritorio de Claude (si desea integrarse con Claude)

Características

Genera automáticamente herramientas MCP a partir de la especificación OpenAPI
Admite todos los endpoints de la API de YCloud
Admite autenticación de API
Maneja automáticamente los tipos de parámetros y la validación
Admite el manejo de solicitudes y respuestas HTTP

Instalación

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

# 安装依赖
npm install

# 构建项目
npm run build

Uso

Obtener la clave de API

Para usar la API de YCloud, necesita una clave de API para autenticarse:

Inicie sesión en la consola de YCloud
Navegue a la página de desarrolladores
En esta página, puede encontrar su clave de API

La clave de API debe incluirse como encabezado de solicitud X-API-Key en todas las solicitudes de API.

Configuración de variables de entorno

Puede configurar el servidor mediante las siguientes variables de entorno:

API_BASE_URL: URL base de la API de YCloud (predeterminado: https://api.ycloud.com/v2)
OPENAPI_SPEC_PATH: Ruta o URL de la especificación OpenAPI (predeterminado: https://docs.ycloud.com/openapi.json)
API_HEADERS: Encabezados de solicitud de API (formato: key1:value1,key2:value2)

Integración con el escritorio de Claude

Para usar este servidor en la aplicación de escritorio de Claude, edite el archivo de configuración de Claude:

Busque o cree el archivo de configuración de escritorio de Claude:
- En macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- En Windows: %APPDATA%\Claude\claude_desktop_config.json
Agregue la siguiente configuración:

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

Reemplace your-api-key-here con su clave de API de YCloud

Ejecución directa

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

Ejemplos

En Claude, puede usar los siguientes prompts para interactuar con la API de YCloud:

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

Claude podrá llamar a los endpoints de API apropiados y devolver los resultados.

Depuración

Durante el desarrollo, puede depurar el servidor MCP utilizando los siguientes métodos:

Ver los registros del servidor: el servidor genera información de depuración durante la ejecución
Usar MCP Inspector: puede utilizar la herramienta MCP Inspector para verificar el estado de ejecución del servidor
Depuración en el escritorio de Claude: puede ver el estado y los registros del servidor en la aplicación de escritorio de Claude

Contribuciones

Se aceptan Pull Requests o la creación de Issues para mejorar este proyecto.

Licencia

MIT