OpenAPI

What is OpenAPI MCP Server?

OpenAPI MCP Server is a Model Context Protocol (MCP) server designed for AI models such as Claude and Cursor. Its primary function is to facilitate the searching and exploration of OpenAPI specifications from oapis.org, allowing AI to process and understand these complex API definitions through natural language.

How to use OpenAPI MCP Server?

OpenAPI MCP Server can be installed via Smithery or npx. Once installed, AI clients like Claude Desktop can leverage it to interact with OpenAPI specifications. For example, you can ask Claude to "Find information about the Stripe API" or "Explain how to use the GitHub API's repository endpoints." The MCP server will then process these requests by first getting an overview of the requested API and then retrieving specific operation details as needed.

Installation:

• Via Smithery:

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

• Via npx:

  npx openapi-mcp-server@latest init
  

Key Features of OpenAPI MCP Server

• Overview of OpenAPI Specifications: Provides a high-level understanding of any OpenAPI specification.
• Detailed API Operation Retrieval: Enables retrieval of specific details about API operations.
• JSON and YAML Support: Compatible with both JSON and YAML formats for OpenAPI specifications.
• AI Model Compatibility: Tested and works with Claude Desktop and Cursor.
• Simplified API Interaction: Translates complex OpenAPI details into simple language for AI comprehension.

Use Cases of OpenAPI MCP Server

• AI-powered API Exploration: Allows AI models to explore and understand various APIs defined by OpenAPI specifications.
• Code Generation: Excellent for generating code based on API definitions, even though it currently doesn't support direct execution of endpoints due to authentication challenges.
• Developer Assistance: Helps developers and AI models quickly grasp API functionalities without deep diving into raw specifications.

FAQ about OpenAPI MCP Server

• Does OpenAPI MCP Server allow executing API endpoints directly? No, OpenAPI MCP v2 does not currently allow executing endpoints directly as tools, primarily due to unsolved authentication problems within the MCP framework. Its focus is on exploration and providing context.

• What are the system requirements for OpenAPI MCP Server? You need Node.js version 16.17.0 or higher and an MCP client such as Claude Desktop or Cursor.

• Can I contribute to the OpenAPI MCP Server project? Yes, the project is open to contributors. You can reach out to the owner via DM on X (formerly Twitter).

• How does the MCP process work? The MCP follows a 3-step process: 1) Identifies the necessary OpenAPI identifier, 2) Requests a summary of it in simple language, and 3) Determines required endpoints and explains their functionality in simple language.

• Is there an older version of OpenAPI MCP Server available? Yes, versions prior to v2.0.0 are still accessible, and their README is available here.

OpenAPI MCP Server

A Model Context Protocol (MCP) server for Claude/Cursor that enables searching and exploring OpenAPI specifications through oapis.org.

• Demo: https://x.com/janwilmake/status/1903497808134496583
• HN Thread: https://news.ycombinator.com/item?id=43447278
• OpenAPISearch: https://github.com/janwilmake/openapisearch
• OAPIS: https://github.com/janwilmake/oapis

The MCP works by applying a 3 step process :

1. It figures out the openapi identifier you need
2. It requests a summary of that in simple language
3. It determines which endpoints you need, and checks out how exactly they work (again, in simple language)

[!IMPORTANT] OpenAPI MCP has found a new owner and has been migrated from v1.2 to v2, which works different to the previous version. You can still access any version prior to v2.0.0 and their README is here

OpenAPI MCP v2 is a Work In Progress and focuses on exploration and providing context about APIs. It does not allow executing the endpoints as tools directly, as authentication isn't a solved problem with MCP yet. However, it's great for codegen!

Expect bugs. Open To Contributers, DM

Features

• Get an overview of any OpenAPI specification
• Retrieve details about specific API operations
• Support for both JSON and YAML formats
• Tested with Claude Desktop and Cursor

Summary	Prompt it
Basic understanding of the OpenAPI MCP Server
Core implementation details of the MCP server
How to extend or contribute to the project

Installation

Installing via Smithery

To install openapi-mcp-server for Claude Desktop automatically via Smithery:

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

Installing via npx

Run and follow instructions:

npx openapi-mcp-server@latest init

Usage in Claude

Once installed, you can ask Claude to:

• "Find information about the Stripe API"
• "Explain how to use the GitHub API's repository endpoints"

Claude will use the MCP server to:

1. First get an overview of the requested API
2. Then retrieve specific operation details as needed

Requirements

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

License

MIT