OpenAPI Schema

Servidor de Protocolo de Contexto de Modelo OpenAPI Schema

Un servidor de Protocolo de Contexto de Modelo (MCP) que expone información de esquemas OpenAPI a Modelos de Lenguaje Grande (LLMs) como Claude. Este servidor permite a un LLM explorar y comprender especificaciones OpenAPI a través de un conjunto de herramientas especializadas.

Características

• Cargar cualquier archivo de esquema OpenAPI (JSON o YAML) especificado mediante argumento de línea de comandos
• Explorar rutas, operaciones, parámetros y esquemas de la API
• Ver esquemas detallados de solicitudes y respuestas
• Consultar definiciones y ejemplos de componentes
• Buscar en toda la especificación de la API
• Obtener respuestas en formato YAML para una mejor comprensión por parte del LLM

Uso

Línea de comandos

Ejecute el servidor MCP con un archivo 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

Integración con Claude Desktop

Para usar este servidor MCP con Claude Desktop, edite su archivo de configuración claude_desktop_config.json:

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

Ubicación del archivo de configuración:

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

Integración con Claude Code

Para usar este servidor MCP con Claude Code CLI, siga estos pasos:

1. Agregue el servidor MCP de OpenAPI Schema a 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 que el servidor MCP esté registrado

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

3. Elimine el servidor si es necesario

   claude mcp remove openapi-schema
   

4. Use la herramienta en Claude Code

   Una vez configurado, puede invocar la herramienta en su sesión de Claude Code haciendo preguntas sobre el esquema OpenAPI.

Consejos:

• Use la bandera -s o --scope con project (predeterminado) o global para especificar dónde se almacena la configuración
• Agregue múltiples servidores MCP para diferentes APIs con diferentes nombres

Herramientas MCP

El servidor proporciona las siguientes herramientas para que los LLMs interactúen con esquemas OpenAPI:

• list-endpoints: Lista todas las rutas de API y sus métodos HTTP con resúmenes en una estructura de objetos anidada
• get-endpoint: Obtiene información detallada sobre un endpoint específico, incluidos parámetros y respuestas
• get-request-body: Obtiene el esquema del cuerpo de la solicitud para un endpoint y método específicos
• get-response-schema: Obtiene el esquema de respuesta para un endpoint, método y código de estado específicos
• get-path-parameters: Obtiene los parámetros para una ruta específica
• list-components: Lista todos los componentes de esquema (esquemas, respuestas, parámetros, etc.)
• get-component: Obtiene la definición detallada de un componente específico
• list-security-schemes: Lista todos los esquemas de seguridad disponibles
• get-examples: Obtiene ejemplos para un componente o endpoint específico
• search-schema: Busca en rutas, operaciones y esquemas

Ejemplos

Ejemplos de consultas para probar:

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.