OpenAPI

OpenAPI Schema Model Context Protocol Server

javascript

47

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

This MCP server lets you load an OpenAPI schema and expose its paths, operations, parameters, and schemas to Large Language Models in a structured, searchable way. It’s useful for LLMS to explore API definitions, understand request/response contracts, and reason about API behavior without manual digging through the spec.

How to use

You interact with the OpenAPI Schema MCP server through an MCP client. Start the server with a specific OpenAPI file, then ask the MCP client to list endpoints, inspect details for particular paths, or look up schemas and examples. You can also have the server return responses in YAML format to make it easier for the model to read.

Basic usage patterns include loading a schema file and querying endpoints, parameters, request bodies, response schemas, and components. Use dedicated tools to search across the API specification and to retrieve exact definitions for components and examples.

How to install

Prerequisites: you need Node.js and npm installed on your system to run MCP servers with npx.

Install and run the MCP server with a specific OpenAPI file by using the following command structure. The server accepts a path to your OpenAPI schema file (JSON or YAML). You can point it at a relative path or an absolute path.

Available tools

list-endpoints

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

get-endpoint

Provides detailed information about a specific endpoint, including parameters and responses.

get-request-body

Retrieves the request body schema for a given endpoint and method.

get-response-schema

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

get-path-parameters

Fetches the parameters defined for a particular path.

list-components

Lists all schema components such as schemas, responses, and parameters.

get-component

Shows a detailed definition for a selected component.

list-security-schemes

Lists all available security schemes in the API.

get-examples

Gets examples for a specific component or endpoint.

search-schema

Searches across paths, operations, and schemas for a query.