openapi-mcp-server  by janwilmake

MCP server for exploring OpenAPI specs via simple language

Created 9 months ago
813 stars

Top 43.6% on SourcePulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

This project provides a Model Context Protocol (MCP) server designed to help AI models like Claude and Cursor understand and explore complex OpenAPI specifications using natural language. It targets developers and AI users who need to integrate with or understand various APIs without deep diving into raw OpenAPI definitions. The benefit is simplified API discovery and comprehension for AI-driven workflows.

How It Works

The server processes OpenAPI specifications in a three-step sequence. First, it identifies the relevant OpenAPI identifier. Second, it generates a simplified, natural-language summary of the API. Finally, it determines and explains the specific endpoints required for a given task, also in plain language. This approach abstracts away the technical jargon of OpenAPI, making API details accessible to AI agents.

Quick Start & Requirements

  • Installation: npx -y @smithery/cli install @janwilmake/openapi-mcp-server --client claude or npx openapi-mcp-server@latest init.
  • Prerequisites: Node.js >= 16.17.0, and an MCP client such as Claude Desktop or Cursor.
  • Setup: Follow interactive prompts after running init.

Highlighted Details

  • Supports both JSON and YAML OpenAPI formats.
  • Tested with Claude Desktop and Cursor.
  • Facilitates API exploration and context retrieval for AI.
  • Useful for code generation tasks.

Maintenance & Community

The project is open to contributors. Further details on community or roadmap are not explicitly provided in the README.

Licensing & Compatibility

  • License: MIT.
  • Compatibility: Permissive MIT license allows for commercial use and integration with closed-source applications.

Limitations & Caveats

Version 2.0.0 is a work in progress and focuses on exploration, not direct endpoint execution, as authentication is not yet implemented. Users should expect potential bugs.

Health Check
Last Commit

1 week ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
1
Star History
39 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.