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.
Overview
The MCP operates in three steps:
- Identifies the OpenAPI identifier needed.
- Requests a summary in simple language.
- Determines necessary endpoints and explains how they work.
Note: OpenAPI MCP has a new owner and has been migrated from v1.2 to v2, which functions differently. Previous versions are still accessible.
OpenAPI MCP v2 focuses on exploration and providing context about APIs but does not support executing endpoints directly due to unsolved authentication issues. It's suitable for code generation.
Features
- Overview of any OpenAPI specification
- Details about specific API operations
- Support for JSON and YAML formats
- Tested with Claude Desktop and Cursor
Installation
Run and follow the instructions:
npx openapi-mcp-server init
Usage in Claude
After installation, 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 provide API overviews and specific operation details.
Requirements
- Node.js >= 16.17.0
- Claude Desktop, Cursor, or any other MCP client.
License
MIT