OpenAPI Schema

by hannesj

20 stars

570 downloads

Not rated

GitHub

About

Transforms OpenAPI specifications into YAML-formatted tools for exploring API paths, operations, parameters, schemas, and security definitions, enabling seamless API documentation navigation and understanding.

Details

Author: hannesj
Repository: hannesj/mcp-openapi-schema
GitHub stars: 20
Downloads: 570
Categories: Developer Tools, Productivity, Design, Workplace, File Management, AI, Search, Knowledge Base, Security, API

- Load any OpenAPI schema file (JSON or YAML) specified via command line argument
- Explore API paths, operations, parameters, and schemas
- View detailed request and response schemas
- Look up component definitions and examples
- Search across the entire API specification
- Get responses in YAML format for better LLM comprehension

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below
Plugin Name OpenAPI Schema

Command (node, npx, python, etc.) npx
Arguments
- Argument 1 -y
- Argument 2 mcp-openapi-schema
- Argument 3 /ABSOLUTE/PATH/TO/openapi.yaml
Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "$$env:AppData\\Claude",
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": true,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "$$env:AppData\\Claude",
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": true,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "$$env:AppData\\Claude",
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": true,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "$$env:AppData\\Claude",
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": true,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "$$env:AppData\\Claude",
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": true,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

From the repository

claude mcp list

`list-endpoints`

Lists all API paths and their HTTP methods with summaries in a nested object structure.

`get-endpoint`

Gets detailed information about a specific endpoint including parameters and responses.

`get-request-body`

Gets the request body schema for a specific endpoint and method.

`get-response-schema`

Gets the response schema for a specific endpoint, method, and status code.

`get-path-parameters`

Gets the parameters for a specific path.

`list-components`

Lists all schema components (schemas, responses, parameters, etc.).

`get-component`

Gets detailed definition for a specific component.

`list-security-schemes`

Lists all available security schemes.

`get-examples`

Gets examples for a specific component or endpoint.

`search-schema`

Searches across paths, operations, and schemas.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "openapi schema": {
            "cwd": "~/Library/Application Support/Claude",
            "env": {},
            "args": [
                "-y",
                "mcp-openapi-schema",
                "/ABSOLUTE/PATH/TO/openapi.yaml"
            ],
            "shell": false,
            "command": "npx"
        }
    }
}

Linux

{
    "cwd": "~/Library/Application Support/Claude",
    "env": [],
    "args": [
        "-y",
        "mcp-openapi-schema",
        "/ABSOLUTE/PATH/TO/openapi.yaml"
    ],
    "shell": false,
    "command": "npx"
}

Macos

{
    "cwd": "~/Library/Application Support/Claude",
    "env": [],
    "args": [
        "-y",
        "mcp-openapi-schema",
        "/ABSOLUTE/PATH/TO/openapi.yaml"
    ],
    "shell": false,
    "command": "npx"
}

Windows

{
    "cwd": "$$env:AppData\\Claude",
    "env": [],
    "args": [
        "/c",
        "npx",
        "-y",
        "mcp-openapi-schema",
        "/ABSOLUTE/PATH/TO/openapi.yaml"
    ],
    "shell": true,
    "command": "cmd"
}

OpenAPI Schema Model Context Protocol Server

A Model Context Protocol (MCP) server that exposes OpenAPI schema information to Large Language Models (LLMs) like Claude. This server allows an LLM to explore and understand OpenAPI specifications through a set of specialized tools.

Run the MCP server with a specific schema file:

# 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

To use this MCP server with Claude Desktop, edit yourclaude_desktop_config.jsonconfiguration file:

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

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

To use this MCP server with Claude Code CLI, follow these steps:
-

Add the OpenAPI Schema MCP server to 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

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

Once configured, you can invoke the tool in your Claude Code session by asking questions about the OpenAPI schema.

- Use the-sor--scopeflag withproject(default) orglobalto specify where the configuration is stored
- Add multiple MCP servers for different APIs with different names

The server provides the following tools for LLMs to interact with OpenAPI schemas:

- list-endpoints: Lists all API paths and their HTTP methods with summaries in a nested object structure
- get-endpoint: Gets detailed information about a specific endpoint including parameters and responses
- get-request-body: Gets the request body schema for a specific endpoint and method
- get-response-schema: Gets the response schema for a specific endpoint, method, and status code
- get-path-parameters: Gets the parameters for a specific path
- list-components: Lists all schema components (schemas, responses, parameters, etc.)
- get-component: Gets detailed definition for a specific component
- list-security-schemes: Lists all available security schemes
- get-examples: Gets examples for a specific component or endpoint
- search-schema: Searches across paths, operations, and schemas

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.

This is a web browser that enables your coding agent, such as Claude Code, to visit websites on your behalf and assist you in identifying bugs or creating UI test cases.

Create crafted UI components inspired by the best 21st.dev design engineers.

Bring agent evaluations, observability, and synthetic test set generation directly into your IDE for free with Galileo's new MCP server

An MCP server to help AI assistants to answer questions and generate AccelByte Extend SDK code more effectively .

MCP server for AI Diagram Maker — generate beautiful software engineering diagrams directly inside Cursor, Claude Desktop, Claude Code, or any MCP-compatible AI agent

ALAPI MCP Tools,Call hundreds of API interfaces via MCP

AI-powered SVG animation generator that transforms static files into animated SVG components using the Allyson platform

MCP server that gives AI assistants on-demand access to 1,500+ amCharts docs, ~300 code examples, and 1000+ class API references.

APIMatic MCP Server is used to validate OpenAPI specifications using APIMatic. The server processes OpenAPI files and returns validation summaries by leveraging APIMatic’s API.

One shared context layer for AI agents and humans — live API specs, DB schemas, and versioned contracts across repos so every agent and teammate works from the same source of truth.

Build and deploy full-stack Next.js apps with 98 tools for React, AWS, and MongoDB

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

list-endpoints

get-endpoint

get-request-body

get-response-schema

get-path-parameters

list-components

get-component

list-security-schemes

get-examples

search-schema

Claude Desktop / Cursor

Linux

Macos

Windows

OpenAPI Schema Model Context Protocol Server

Install

More like this

Time

Sentry

Github

Git

GitLab

Context 7

`list-endpoints`

`get-endpoint`

`get-request-body`

`get-response-schema`

`get-path-parameters`

`list-components`

`get-component`

`list-security-schemes`

`get-examples`

`search-schema`