Home / MCP / OpenAPI MCP Server

OpenAPI MCP Server

Provides an MCP server for exploring OpenAPI specs via simple language summaries and endpoint details.

typescript

858stars

View on GitHub

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
    "mcpServers": {
        "openapi_mcp": {
            "url": "https://openapi-mcp.openapisearch.com/mcp"
        }
    }
}

You can search, explore, and interact with OpenAPI specifications through a dedicated MCP server. It connects to a centralized MCP endpoint to summarize and expose API operations in simple language, helping you understand how any OpenAPI spec works and what its endpoints do.

How to use

Connect your MCP client to the remote OpenAPI MCP endpoint to browse OpenAPI specs. You can look up an OpenAPI definition, read a plain-language summary, and then drill down into specific API operations to see how they work. Use the provided MCP URL to access the server and start querying OpenAPI specifications through your client.

If you want to test or explore locally, you can start by connecting to the official MCP URL and then use your client’s search and explore features to view overviews of specifications, operation details, and the supported JSON or YAML formats.

How to install

Prerequisites you need on your machine: Node.js and npm, so you can run JavaScript tools and local dev commands. You may also install the Wrangler CLI to run the local server worker during development.

1. Install Wrangler for local development (if you want to run a local worker):
```
npm install -g wrangler

2. Start the local server during development: ``wrangler dev``

3. In a separate terminal, start the MCP inspector to validate and interact with the MCP server:
```
npx @modelcontextprotocol/inspector

Additional information

Connection to the server is done through an MCP URL that is intended for clients. Use the official MCP URL to connect from your MCP client and start exploring OpenAPI specifications without needing to host your own instance.

If you want to try a ready-made remote endpoint, the MCP URL you use for clients is: https://openapi-mcp.openapisearch.com/mcp

Available tools

inspector

Runs the MCP inspector tool to validate, inspect, and interact with MCP servers from the command line.