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.
Features
- 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
Usage
Command Line
Run the MCP server with a specific schema file:
Claude Desktop Integration
To use this MCP server with Claude Desktop, edit your
claude_desktop_config.json configuration file:Location of the configuration file:
- macOS/Linux:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
$env:AppData\Claude\claude_desktop_config.json
Claude Code Integration
To use this MCP server with Claude Code CLI, follow these steps:
- Add the OpenAPI Schema MCP server to Claude Code
- Verify the MCP server is registered
- Remove the server if needed
- Use the tool in Claude CodeOnce configured, you can invoke the tool in your Claude Code session by asking questions about the OpenAPI schema.
Tips:
- Use the
-sor--scopeflag withproject(default) orglobalto specify where the configuration is stored
- Add multiple MCP servers for different APIs with different names
MCP Tools
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
Examples
Example queries to try:
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.
Features
- 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
Usage
Command Line
Run the MCP server with a specific schema file:
Claude Desktop Integration
To use this MCP server with Claude Desktop, edit your
claude_desktop_config.json configuration file:Location of the configuration file:
- macOS/Linux:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
$env:AppData\Claude\claude_desktop_config.json
Claude Code Integration
To use this MCP server with Claude Code CLI, follow these steps:
- Add the OpenAPI Schema MCP server to Claude Code
- Verify the MCP server is registered
- Remove the server if needed
- Use the tool in Claude CodeOnce configured, you can invoke the tool in your Claude Code session by asking questions about the OpenAPI schema.
Tips:
- Use the
-sor--scopeflag withproject(default) orglobalto specify where the configuration is stored
- Add multiple MCP servers for different APIs with different names
MCP Tools
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
Examples
Example queries to try: