Servidor MCP YCloud WhatsApp API | Awesome MCP Servers

Servidor MCP da API YCloud WhatsApp

Este é um servidor da API YCloud WhatsApp construído com base no Model Context Protocol (MCP). Ele gera automaticamente ferramentas a partir da especificação OpenAPI do YCloud WhatsApp, permitindo que modelos de IA (como Claude) interajam diretamente com a API YCloud WhatsApp.

Pré-requisitos

Antes de usar este servidor, você precisa:

Registrar uma conta no site oficial da YCloud
Obter sua chave de API (consulte as instruções abaixo)
Instalar as dependências de software necessárias (consulte as instruções abaixo)

Requisitos do sistema

Node.js v16.0.0 ou superior
npm v7.0.0 ou superior
Aplicativo de desktop Claude (se quiser integrar com Claude)

Recursos

Geração automática de ferramentas MCP a partir da especificação OpenAPI
Suporte a todos os endpoints da API YCloud
Suporte à autenticação da API
Tratamento automático de tipos e validação de parâmetros
Suporte ao processamento de solicitações e respostas HTTP

Instalação

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

# 安装依赖
npm install

# 构建项目
npm run build

Como usar

Obter a chave de API

Para usar a API YCloud, você precisa de uma chave de API para autenticação:

Faça login no console da YCloud
Navegue até a página do desenvolvedor
Nesta página, você pode encontrar sua chave de API

A chave de API deve ser incluída como cabeçalho de solicitação X-API-Key em todas as solicitações da API.

Configuração de variáveis de ambiente

Você pode configurar o servidor por meio das seguintes variáveis de ambiente:

API_BASE_URL: URL base da API YCloud (padrão: https://api.ycloud.com/v2)
OPENAPI_SPEC_PATH: Caminho ou URL da especificação OpenAPI (padrão: https://docs.ycloud.com/openapi.json)
API_HEADERS: Cabeçalhos da solicitação da API (formato: key1:value1,key2:value2)

Integração com o desktop Claude

Para usar este servidor no aplicativo de desktop Claude, edite o arquivo de configuração do Claude:

Encontre ou crie o arquivo de configuração do desktop Claude:
- No macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- No Windows: %APPDATA%\Claude\claude_desktop_config.json
Adicione a seguinte configuração:

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

Substitua your-api-key-here pela sua chave de API YCloud

Execução direta

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

Exemplos

No Claude, você pode usar os seguintes prompts para interagir com a API YCloud:

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

O Claude poderá chamar os endpoints apropriados da API e retornar os resultados.

Depuração

Durante o desenvolvimento, você pode usar os seguintes métodos para depurar o servidor MCP:

Visualizar os logs do servidor: o servidor gera informações de depuração durante a execução
Usar o MCP Inspector: você pode usar a ferramenta MCP Inspector para verificar o status de execução do servidor
Depuração no desktop Claude: você pode visualizar o status e os logs do servidor no aplicativo de desktop Claude

Contribuição

Pull Requests ou Issues são bem-vindos para melhorar este projeto.

Licença

MIT

YCloud WhatsApp API

Documentação