Explore OpenAPI Specs Efficiently
Explore OpenAPI/Swagger specs efficiently via MCP. Access API details without loading full files. Supports v3.0 & v2.0.
1.0.0Add to Favorites
Why it matters
Access and explore OpenAPI (v3.0) and Swagger (v2.0) specifications through MCP Resources. This allows for token-efficient querying of API details without loading entire files into context.
Outcomes
What it gets done
Query API structure and details via intuitive URIs.
Retrieve information on paths, operations, and components.
Support for local and remote OpenAPI/Swagger files.
Automatic conversion of Swagger v2.0 to OpenAPI v3.0.
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/vb-openapi-schema-explorer | bash Overview
OpenAPI Schema Explorer MCP Server
What it does
This MCP server provides token-efficient access to OpenAPI (v3.0) and Swagger (v2.0) specifications through MCP Resources, allowing you to explore API specifications without loading entire files into context.
How it connects
Use this MCP server to explore API specification structure and details, view API paths and operations, study component schemas and definitions, get details for specific HTTP methods on API paths, and list available components by type. It supports token-efficient access to specifications.
Source README
An MCP server that provides token-efficient access to OpenAPI (v3.0) and Swagger (v2.0) specifications through MCP Resources, allowing you to explore API specifications without loading entire files into context.
Installation
NPX (Recommended)
npx -y mcp-openapi-schema-explorer@latest <path-or-url-to-spec>
Docker
docker run --rm -i kadykov/mcp-openapi-schema-explorer:latest <path-or-url-to-spec>
Global Installation
npm install -g mcp-openapi-schema-explorer
From Source
git clone https://github.com/kadykov/mcp-openapi-schema-explorer.git
cd mcp-openapi-schema-explorer
npm install
npm run build
Configuration
NPX Configuration
{
"mcpServers": {
"My API Spec (npx)": {
"command": "npx",
"args": [
"-y",
"mcp-openapi-schema-explorer@latest",
"<path-or-url-to-spec>",
"--output-format",
"yaml"
],
"env": {}
}
}
}
Docker Configuration for Remote Files
{
"mcpServers": {
"My API Spec (Docker Remote)": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"kadykov/mcp-openapi-schema-explorer:latest",
"<remote-url-to-spec>"
],
"env": {}
}
}
}
Docker Configuration for Local Files
{
"mcpServers": {
"My API Spec (Docker Local)": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-v",
"/full/host/path/to/spec.yaml:/spec/api.yaml",
"kadykov/mcp-openapi-schema-explorer:latest",
"/spec/api.yaml",
"--output-format",
"yaml"
],
"env": {}
}
}
}
Features
- Access MCP resources through intuitive URIs (openapi://info, openapi://paths/..., openapi://components/...)
- Support for OpenAPI v3.0 and Swagger v2.0 with automatic v2.0 to v3.0 conversion
- Support for local and remote files (file paths or HTTP/HTTPS URLs)
- Token-efficient design to minimize token usage in LLMs
- Multiple output formats (JSON, YAML, minified JSON)
- Dynamic server name reflecting info.title from the loaded specification
- Transform internal $refs links into clickable MCP URIs
- Support for multi-value parameters to retrieve multiple items in a single request
Usage Examples
Explore API specification structure and details
View API paths and operations
Study component schemas and definitions
Get details for specific HTTP methods on API paths
List available components by type
Notes
Uses MCP Resources (not tools) for exploring read-only data. Supports multi-value parameters with comma-separated values (e.g., get,post). Path parameters must be URL-encoded. The server name in MCP clients reflects the API specification title.
Trust
How it checks out
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.