Openapi MCP Proxy

🚀 OpenAPI MCP Server

A command-line tool that can convert any OpenAPI service into a Model Context Protocol (MCP) server, enabling seamless integration with AI agents and tools supporting the MCP specification.

⚠️ Important Note

This tool is still in the early stages of development. The roadmap is here

🚀 Quick Start

What is Model Context Protocol (MCP)?

Model Context Protocol (MCP) is a standardized protocol for the interaction between AI agents and external tools and services. It provides a unified way to discover, understand, and utilize various capabilities, making it easier to build AI-driven applications that can interact with multiple services.

What is OpenAPI?

OpenAPI (formerly known as Swagger) is a standard for describing machine-readable interface files, used to define, generate, consume, and visualize RESTful web services. It allows humans and computers to discover and understand the functionality of services without accessing the source code or additional documentation.

About the Project

This middleware acts as a bridge between OpenAPI services and MCP clients:

1. Accepts an OpenAPI specification file as input.
2. Automatically generates a server that complies with the MCP standard.
3. Proxies requests to the actual OpenAPI service.
4. Converts between MCP and REST conventions.

This enables any existing REST API with an OpenAPI specification to be immediately accessible to AI agents that understand MCP, without modifying the original service.

📦 Installation

npm install -g openapi-mcp-proxy

💻 Usage Examples

Basic Usage

npx openapi-mcp-proxy --spec ./path/to/openapi.yml --target http://your-api.com --port 3000

Options

• -s, --spec <path> (Required): Path to the OpenAPI specification file (Environment variable: OMP_OPENAPI_SPEC_FILE).
• -t, --target <url> (Optional): Target API service URL (Default: "http://localhost:8080", Environment variable: OMP_TARGET_BASE_URL).
• -p, --port <number> (Optional): Port on which the MCP server runs (Default: "3000", Environment variable: PORT).
• -V, --version: Display the version number.
• -h, --help: Display help information.

Advanced Usage

Start the MCP server for the Petstore API:

npx openapi-mcp-proxy --spec resources/petstore.openapi.yml --target https://petstore.swagger.io/v2

Testing

MCP Check Tool

To test your MCP server, do the following:

1. Install the check tool: npm install -g @merossai/mcpx.
2. Start the check tool: mcpx <your_api_key> http://localhost:3000.

Configuration in VS Code

In VS Code, you can press Ctrl+Shift+P to open the command palette:

1. Type and select "Remote-Containers: Start Server".
2. Configure the proxy settings:
   • Proxy URL: http://localhost:3000.
   • Directly connect to the target port: true.

🤝 Contribution

Contributions to this project are welcome! If you have any questions or suggestions, please submit an issue or a pull request.

📄 License

This project is protected by the MIT license.