Servidor de protocolo de contexto de modelo de esquema OpenAPI

Un servidor de Protocolo de Contexto de Modelo (MCP) que expone la información del esquema OpenAPI a Modelos de Lenguaje Grandes (LLM) como Claude. Este servidor permite a un LLM explorar y comprender las especificaciones de OpenAPI mediante un conjunto de herramientas especializadas.

Características

• Cargue cualquier archivo de esquema OpenAPI (JSON o YAML) especificado mediante el argumento de la línea de comandos

• Explorar rutas de API, operaciones, parámetros y esquemas

• Ver esquemas detallados de solicitud y respuesta

• Busque definiciones de componentes y ejemplos

• Buscar en toda la especificación de API

• Obtenga respuestas en formato YAML para una mejor comprensión del LLM

Related MCP server: openapi-mcp-proxy

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 de escritorio de Claude

Para utilizar 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

• Ventanas: $env:AppData\Claude\claude_desktop_config.json

Integración de Claude Code

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

1. Agregue el servidor MCP de esquema OpenAPI 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. Quitar el servidor si es necesario

   claude mcp remove openapi-schema

4. Utilice la herramienta en Claude Code

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

Consejos:

• Utilice el indicador -s o --scope con project (predeterminado) o global para especificar dónde se almacena la configuración

• Agregue varios servidores MCP para diferentes API con diferentes nombres

Herramientas MCP

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

• list-endpoints : enumera todas las rutas de API y sus métodos HTTP con resúmenes en una estructura de objeto anidado

• get-endpoint : obtiene información detallada sobre un punto final específico, incluidos parámetros y respuestas

• get-request-body : obtiene el esquema del cuerpo de la solicitud para un punto final y un método específicos

• get-response-schema : obtiene el esquema de respuesta para un punto final, un método y un código de estado específicos

• get-path-parameters : obtiene los parámetros para una ruta específica

• list-components : enumera todos los componentes del esquema (esquemas, respuestas, parámetros, etc.)

• get-component : obtiene la definición detallada de un componente específico

• list-security-schemes : enumera todos los esquemas de seguridad disponibles

• get-examples : obtiene ejemplos para un componente o punto final 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.