OpenAPI Explorer MCP Server

Developer ToolsJavaScript

Search and explore OpenAPI specifications through natural language

Available Tools

searchOpenAPI

Search for OpenAPI specifications by name or description

getOpenAPIOverview

Get a high-level overview of an OpenAPI specification

getOperationDetails

Get detailed information about specific API operations

OpenAPI Explorer enables AI assistants to search, navigate, and understand complex API documentation through simple natural language. It connects to oapis.org to provide comprehensive information about thousands of public APIs, making it easier to discover and learn how to use them. The tool works through a three-step process: first identifying the relevant OpenAPI specification, then providing a summary in simple language, and finally exploring specific endpoints with detailed explanations. This approach makes complex API documentation accessible without requiring users to wade through technical specifications.

Overview

OpenAPI Explorer allows AI assistants like Claude to search and explore OpenAPI specifications through natural language queries. Instead of manually parsing complex API documentation, you can ask questions about APIs and get clear, concise explanations.

Installation

You have several options to install the OpenAPI Explorer:

Option 1: Install via Smithery

For Claude Desktop users, the easiest installation method is via Smithery:

npx -y @smithery/cli install @janwilmake/openapi-mcp-server --client claude

This command will automatically configure the MCP server for Claude Desktop.

Option 2: Install via npx

Run the following command and follow the interactive prompts:

npx openapi-mcp-server@latest init

Option 3: Manual Installation

Clone the repository:

git clone https://github.com/janwilmake/openapi-mcp-server.git

Navigate to the directory and install dependencies:
```
cd openapi-mcp-server
npm install
```
Start the server:
```
node index.js
```
Configure your AI assistant to use the MCP server by adding the appropriate configuration to your client settings.

Usage

Once installed, you can interact with the OpenAPI Explorer through natural language queries. Here are some examples of what you can ask:

"Find information about the Stripe API"
"Explain how to use the GitHub API's repository endpoints"
"What endpoints are available in the Twitter API?"
"How do I authenticate with the Shopify API?"
"Show me how to create a new user with the Auth0 API"

The OpenAPI Explorer will:

Identify the API you're interested in
Provide a high-level overview of the API
Retrieve specific details about endpoints as needed

Limitations

The current version focuses on exploration and providing context about APIs
It does not allow executing API endpoints directly as tools
Authentication for APIs is not handled by the MCP server

Requirements

Node.js >= 16.17.0
Claude Desktop, Cursor, or any other MCP-compatible client