Swagger/OpenAPI MCP Server

Swagger/OpenAPI MCP Server

Um servidor Model Context Protocol (MCP) que permite que LLMs explorem e interajam com especificações Swagger/OpenAPI. Este servidor fornece ferramentas e recursos para carregar especificações de API, navegar por endpoints e obter informações detalhadas sobre operações de API.

Instalação

1. Clone ou crie o diretório do projeto
2. Instale as dependências:

npm install

3. Compile o código TypeScript:

npm run build

Uso

Ferramentas Disponíveis

load_api

Carregue uma especificação OpenAPI/Swagger no servidor.

Parâmetros:

• apiId (string): Identificador único para esta API
• source (string): URL ou caminho de arquivo para a especificação OpenAPI/Swagger

Exemplo:

{
  "name": "load_api",
  "arguments": {
    "apiId": "petstore",
    "source": "https://petstore.swagger.io/v2/swagger.json"
  }
}

get_endpoint_details

Obtenha informações detalhadas sobre um endpoint de API específico.

Parâmetros:

• apiId (string): ID da API carregada
• method (string): Método HTTP (GET, POST, etc.)
• path (string): Caminho do endpoint da API
• natural (boolean, opcional): Se verdadeiro, retorna um resumo legível por humanos

Exemplo:

{
  "name": "get_endpoint_details",
  "arguments": {
    "apiId": "petstore",
    "method": "GET",
    "path": "/pet/{petId}",
    "natural": true
  }
}

list_apis

Liste todas as especificações de API atualmente carregadas.

Parâmetros: Nenhum

search_endpoints

Pesquise endpoints que correspondam a um padrão específico.

Parâmetros:

• apiId (string): ID da API carregada
• pattern (string): Padrão de pesquisa para caminhos de endpoint ou descrições

Exemplo:

{
  "name": "search_endpoints",
  "arguments": {
    "apiId": "petstore",
    "pattern": "pet"
  }
}

Recursos Disponíveis

swagger://{apiId}/load

Obtenha informações gerais sobre uma especificação de API carregada.

swagger://{apiId}/endpoints

Obtenha uma lista de todos os endpoints disponíveis para uma API.

swagger://{apiId}/endpoint/{method}/{path}

Obtenha informações detalhadas sobre um endpoint específico.

Configuração com Claude Desktop

Para usar este servidor com Claude Desktop, adicione o seguinte ao seu claude_desktop_config.json:

{
  "mcpServers": {
    "swagger-explorer": {
      "command": "node",
      "args": ["/path/to/your/swagger-mcp-server/build/index.js"]
    }
  }
}

Substitua /path/to/your/swagger-mcp-server pelo caminho real do seu diretório de projeto.

Licença

Licença MIT