openapi-mcp-server
by: janwilmake
Allow AI to wade through complex OpenAPIs using Simple Language
📌Overview
Purpose: To provide a structured and user-friendly way to search and explore OpenAPI specifications using the Model Context Protocol (MCP).
Overview: OpenAPI MCP Server offers a platform for developers to understand OpenAPI specifications through a simple three-step process. It identifies the required OpenAPI document, delivers a summary in plain language, and clarifies how to interact with specific API endpoints.
Key Features:
-
Overview of OpenAPI Specifications: Provides comprehensive insights into any OpenAPI specification to aid developers in understanding APIs.
-
Detailed Operation Retrieval: Allows users to access in-depth information on specific API operations, ensuring clarity on functionality.
-
Support for Multiple Formats: Compatible with both JSON and YAML formats, catering to varied preferences in data representation.
-
Compatibility Testing: Successfully tested with Claude Desktop and Cursor for seamless integration with existing tools.
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:
- It figures out the OpenAPI identifier you need.
- It requests a summary of that in simple language.
- 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 differently from the previous version.
You can still access any version prior to v2.0.0 and their README is available separately.
OpenAPI MCP v2 is a Work In Progress, focusing on exploration and providing context about APIs.
It does not allow executing the endpoints as tools directly, as authentication isn't solved with MCP yet. However, it's great for code generation!
Expect bugs. Open to contributors.
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
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:
- First get an overview of the requested API
- Then retrieve specific operation details as needed
Requirements
- Node.js >= 16.17.0
- Claude Desktop, Cursor, or any other MCP client.
License
MIT