OpenAPI Schema

OpenAPI Schema Model Context Protocol Server

Um servidor Model Context Protocol (MCP) que expõe informações de esquema OpenAPI para Modelos de Linguagem de Grande Porte (LLMs) como o Claude. Este servidor permite que um LLM explore e compreenda especificações OpenAPI por meio de um conjunto de ferramentas especializadas.

Recursos

• Carregar qualquer arquivo de esquema OpenAPI (JSON ou YAML) especificado via argumento de linha de comando
• Explorar caminhos, operações, parâmetros e esquemas da API
• Visualizar esquemas detalhados de requisição e resposta
• Consultar definições e exemplos de componentes
• Pesquisar em toda a especificação da API
• Obter respostas em formato YAML para melhor compreensão do LLM

Uso

Linha de Comando

Execute o servidor MCP com um arquivo de esquema específico:

# Use the default openapi.yaml in current directory
npx -y mcp-openapi-schema

# Use a specific schema file (relative path)
npx -y mcp-openapi-schema ../petstore.json

# Use a specific schema file (absolute path)
npx -y mcp-openapi-schema /absolute/path/to/api-spec.yaml

# Show help
npx -y mcp-openapi-schema --help

Integração com Claude Desktop

Para usar este servidor MCP com o Claude Desktop, edite seu arquivo de configuração claude_desktop_config.json:

{
  "mcpServers": {
    "OpenAPI Schema": {
      "command": "npx",
      "args": ["-y", "mcp-openapi-schema", "/ABSOLUTE/PATH/TO/openapi.yaml"]
    }
  }
}

Localização do arquivo de configuração:

• macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: $env:AppData\Claude\claude_desktop_config.json

Integração com Claude Code

Para usar este servidor MCP com a CLI do Claude Code, siga estas etapas:

1. Adicione o servidor MCP OpenAPI Schema ao Claude Code

   # Basic syntax
   claude mcp add openapi-schema npx -y mcp-openapi-schema
   
   # Example with specific schema
   claude mcp add petstore-api npx -y mcp-openapi-schema ~/Projects/petstore.yaml
   

2. Verifique se o servidor MCP está registrado

   # List all configured servers
   claude mcp list
   
   # Get details for your OpenAPI schema server
   claude mcp get openapi-schema
   

3. Remova o servidor se necessário

   claude mcp remove openapi-schema
   

4. Use a ferramenta no Claude Code

   Depois de configurado, você pode invocar a ferramenta na sua sessão do Claude Code fazendo perguntas sobre o esquema OpenAPI.

Dicas:

• Use a flag -s ou --scope com project (padrão) ou global para especificar onde a configuração é armazenada
• Adicione vários servidores MCP para diferentes APIs com nomes diferentes

Ferramentas MCP

O servidor fornece as seguintes ferramentas para LLMs interagirem com esquemas OpenAPI:

• list-endpoints: Lista todos os caminhos da API e seus métodos HTTP com resumos em uma estrutura de objeto aninhada
• get-endpoint: Obtém informações detalhadas sobre um endpoint específico, incluindo parâmetros e respostas
• get-request-body: Obtém o esquema do corpo da requisição para um endpoint e método específicos
• get-response-schema: Obtém o esquema de resposta para um endpoint, método e código de status específicos
• get-path-parameters: Obtém os parâmetros para um caminho específico
• list-components: Lista todos os componentes do esquema (esquemas, respostas, parâmetros, etc.)
• get-component: Obtém a definição detalhada de um componente específico
• list-security-schemes: Lista todos os esquemas de segurança disponíveis
• get-examples: Obtém exemplos para um componente ou endpoint específico
• search-schema: Pesquisa em caminhos, operações e esquemas

Exemplos

Exemplos de consultas para experimentar:

What endpoints are available in this API?
Show me the details for the POST /pets endpoint.
What parameters does the GET /pets/{petId} endpoint take?
What is the request body schema for creating a new pet?
What response will I get from the DELETE /pets/{petId} endpoint?
What schemas are defined in this API?
Show me the definition of the Pet schema.
What are the available security schemes for this API?
Are there any example responses for getting a pet by ID?
Search for anything related to "user" in this API.