Openapi Mcpserver Generator

🚀 OpenAPI to MCP Server Generator

A command-line tool that generates Model Context Protocol (MCP) server code from an OpenAPI specification. This tool helps you quickly create an MCP server as a bridge between large language models (LLMs) and your APIs.

English | Simplified Chinese

🚀 Quick Start

Initial Idea

This repository was initially forked from openapi-mcp-generator and some additional features were added:

• Support for nested $ref in the OpenAPI specification.
• Generation of MCP server configuration in addition to source code.
• Allowing clients to set the log level and send log messages as notifications to the client.
• Sending error messages to stderr when errors occur.

✨ Features

• Automated Tool Generation: Converts each API endpoint in your OpenAPI specification into an MCP tool.
• Easy Installation: Can be easily installed and run using npm.
• Powerful Configuration: Supports multiple security schemes, including OAuth2 and OpenID Connect.
• Flexible Logging: Allows customizing the log level and output format.

📦 Installation

npm install -g openapi-mcp-generator

💻 Usage Examples

Basic Usage

1. First, install the tool:

   npm install -g openapi-mcp-generator
   

2. Then, run the generator:

   oai-mcp generate --input your_openapi_spec.yaml --output ./mcp-server
   

3. Finally, start the generated MCP server:

   cd mcp-server && npm start
   

Advanced Usage

Supported Security Schemes

OpenAPI 3.0 supports four security types:

• apiKey: Example:

    "securitySchemes": {
        "my_api_key": {
            "type": "apiKey",
            "name": "api_key",
            "in": "header"
        }
    }
  

  It expects to find an uppercase environment variable in .env: MY_API_KEY_API_KEY.

• http: Example:

    "securitySchemes": {
        basicAuth: {
           type: "http",
           scheme: "basic"
        }
    }
  

  It tries to get BASICAUTH_USERNAME and BASICAUTH_PASSWORD from .env.

• oauth2: Due to the complexity of /oauth2/, it cannot be handled automatically. It is recommended to manually obtain an access token and set it in .env as:

  API_HEADERS=Authorization:Bearer your-access-token-here
  

• openIdConnect Currently not supported.

Custom Log Level

You can specify the log level in the generator:

oai-mcp generate --input your_openapi_spec.yaml --output ./mcp-server --log-level debug

📄 License

Apache 2.0