Openapi Proxy

🚀 OpenAPI MCP Server

A command-line tool that converts 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 development roadmap is here

🚀 Quick Start

What is Model Context Protocol (MCP)?

The Model Context Protocol (MCP) is a standard protocol for AI agents to interact with external tools and services. It provides a unified way for AI models to discover, understand, and utilize various functions, simplifying the process of building AI-driven applications that support multiple services.

What is OpenAPI?

OpenAPI (formerly known as Swagger) is a machine-readable interface file specification for describing, generating, consuming, and visualizing RESTful web services. It enables humans and computers to discover and understand the capabilities of a service without accessing the source code or additional documentation.

About the Project

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

1. Receives an OpenAPI specification file as input.
2. Automatically generates an MCP-compliant server.
3. Proxies incoming requests to the actual OpenAPI service.
4. Converts between MCP and REST conventions.

This allows any existing REST API with an OpenAPI specification to be immediately available 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 to run the MCP server on (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

📚 Documentation

MCP Inspector

To test your MCP server, you can use the Model Context Protocol Inspector:

1. Install the MCP Inspector:

npx @modelcontextprotocol/inspector

2. Start your MCP server.
3. Open the inspector's interface and enter the correct server path (ending with /mcp), for example, http://localhost:3000/mcp.
4. Now you can interact with your MCP server through the MCP inspector. The inspector will display detailed information about requests and responses.

VS Code Usage

1. Open VS Code and install the MCP Proxy plugin.
2. After starting the MCP server, configure the proxy through the following steps:
   • Click the proxy icon in the bottom right corner.
   • Select "Add Proxy".
   • Fill in the proxy name and address (e.g., http://localhost:3000).
3. Set up the proxy configuration file (e.g., .mcp-proxy.json) in your project:

{
  "proxies": {
    "my-api": {
      "target": "https://petstore.swagger.io/v2",
      "proxyUrl": "http://localhost:3000"
    }
  }
}

📄 License

This project is licensed under the MIT License. For more information, see the LICENSE file.