OpenAPI Schema Explorer

v1.0.0Developer Toolsstable

MCP server providing token-efficient access to OpenAPI/Swagger specs via MCP Resource Templates for client-side exploration.

api-specificationdeveloper-toolsdevelopmentmcpmcp-server
Share:
71
Stars
0
Downloads
0
Weekly
0/5

What is OpenAPI Schema Explorer?

OpenAPI Schema Explorer is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to mcp server providing token-efficient access to openapi/swagger specs via mcp resource templates for client-side exploration.

MCP server providing token-efficient access to OpenAPI/Swagger specs via MCP Resource Templates for client-side exploration.

This server falls under the Developer Tools and APIs categories on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • MCP server providing token-efficient access to OpenAPI/Swagg

Use Cases

Explore and understand OpenAPI/Swagger specifications efficiently.
Access API documentation with token-optimized exploration.
Understand API schemas for integration planning.
kadykov

Maintainer

LicenseMIT License
Languagetypescript
Versionv1.0.0
UpdatedMay 11, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

Manual Installation

npx openapi-schema-explorer

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use OpenAPI Schema Explorer

The OpenAPI Schema Explorer MCP server provides token-efficient, read-only access to OpenAPI and Swagger specification files via MCP Resource Templates rather than bulk-loading the entire spec into context. It lets AI assistants navigate API documentation hierarchically — browsing top-level fields, listing paths and their HTTP methods, inspecting individual operation details, and reading component schemas — fetching only the portion of the spec actually needed for each question. This dramatically reduces token usage when working with large API specs and makes it practical for Claude to assist with API integration planning, code generation, and endpoint understanding without hitting context limits.

Prerequisites

  • Node.js 18+ and npx available in your PATH
  • An OpenAPI or Swagger specification file (local path or public URL, JSON or YAML format)
  • An MCP-compatible client such as Claude Desktop, Cursor, or VS Code with MCP support
  • No API keys or accounts required
1

Run the server with npx (no install needed)

Pass your OpenAPI spec file path or URL as the first argument. The server starts immediately without a separate install step.

npx -y mcp-openapi-schema-explorer@latest /path/to/your/openapi.yaml
# or with a URL:
npx -y mcp-openapi-schema-explorer@latest https://api.example.com/openapi.json
2

Configure Claude Desktop with a local spec file

Add the server to claude_desktop_config.json pointing at a local OpenAPI spec. The spec path is passed as an argument to npx.

{
  "mcpServers": {
    "my-api-spec": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-openapi-schema-explorer@latest",
        "/path/to/openapi.yaml"
      ],
      "env": {}
    }
  }
}
3

Or configure with a remote spec URL

For publicly hosted specs, pass the URL directly. The --output-format yaml flag is optional and returns schemas in YAML instead of JSON.

{
  "mcpServers": {
    "petstore-api": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-openapi-schema-explorer@latest",
        "https://petstore3.swagger.io/api/v3/openapi.json",
        "--output-format",
        "yaml"
      ],
      "env": {}
    }
  }
}
4

Restart Claude Desktop

Save the config and restart Claude Desktop. The server exposes Resource Templates (not traditional tools), which Claude can access by navigating the openapi:// URI scheme.

5

Explore your API via resource URIs

Ask Claude to explore the spec using the openapi:// resource template. Claude will call the appropriate resource to fetch only the needed section of the spec.

OpenAPI Schema Explorer Examples

Client configuration (Claude Desktop)

Example config pointing at the public Petstore v3 spec with YAML output format.

{
  "mcpServers": {
    "petstore-api": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-openapi-schema-explorer@latest",
        "https://petstore3.swagger.io/api/v3/openapi.json",
        "--output-format",
        "yaml"
      ],
      "env": {}
    }
  }
}

Prompts to try

Ask Claude to explore, summarize, or help you integrate with the API described in your spec.

- "List all the API paths available in this spec and what HTTP methods they support"
- "Show me the request and response schema for the POST /users endpoint"
- "What authentication schemes does this API require?"
- "Explain the User component schema and all its required fields"
- "Generate a Python requests snippet to call the GET /pets/{petId} endpoint"

Troubleshooting OpenAPI Schema Explorer

Spec file not found or parse error on startup

Ensure the path passed in args is an absolute path to a valid JSON or YAML OpenAPI file. If using a URL, verify it is publicly accessible and returns a valid spec without authentication.

Claude does not seem to use the spec resources when asked about the API

The server exposes MCP Resource Templates rather than tools. Ensure your MCP client version supports resource templates. Ask Claude explicitly to 'read openapi://paths' or 'access the openapi resource' to trigger resource fetching.

Multiple API specs needed simultaneously

Add multiple entries in the mcpServers config block, each with a different key name and a different spec path or URL as the argument. Claude can then reference them by the server name you assign.

Frequently Asked Questions about OpenAPI Schema Explorer

What is OpenAPI Schema Explorer?

OpenAPI Schema Explorer is a Model Context Protocol (MCP) server that mcp server providing token-efficient access to openapi/swagger specs via mcp resource templates for client-side exploration. It connects AI assistants to external tools and data sources through a standardized interface.

How do I install OpenAPI Schema Explorer?

Follow the installation instructions on the OpenAPI Schema Explorer GitHub repository. Clone the repo, install dependencies, and add the server config to your AI client.

Which AI clients work with OpenAPI Schema Explorer?

OpenAPI Schema Explorer works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is OpenAPI Schema Explorer free to use?

Yes, OpenAPI Schema Explorer is open source and available under the MIT License license. You can use it freely in both personal and commercial projects.

Browse More Developer Tools MCP Servers

Explore all developer tools servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "openapi-schema-explorer": { "command": "npx", "args": ["-y", "openapi-schema-explorer"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide →

Ready to use OpenAPI Schema Explorer?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides