Openapi MCP Generator

🚀 OpenAPI to MCP Server Generator

A command-line tool that converts OpenAPI specifications into Model Context Protocol (MCP) compatible servers.

🚀 Quick Start

This tool is designed to transform OpenAPI specifications into MCP - compatible servers. Follow the steps below to get started.

✨ Features

• OpenAPI Support: Supports the OpenAPI 3.0 standard, capable of parsing and generating MCP servers.
• Proxy Behavior: Implements request forwarding functionality and supports multiple authentication methods.
• Authentication Support: Includes various authentication schemes such as API Key, Bearer Token, Basic Auth, and OAuth2.
• Zod Validation: Uses Zod for data validation to ensure the legitimacy of inputs and outputs.
• Multiple Transport Modes: Supports standard input - output (stdio), SSE - based Web servers, and streaming HTTP transport.

📦 Installation

npm install -g @your-package-name

💻 Usage Examples

Basic Usage

1. Initialize the project:

mcp-server init your-project-name

2. Fill in the OpenAPI configuration file as prompted.
3. Start the server:

cd your-project-name
npm start

Advanced Usage

Transport Mode Selection

• stdio Mode: Suitable for local development and integration into LLM tools.
• Web Server (SSE): Provides bidirectional message communication based on SSE, supporting multiple connections and browser clients.
• Streaming HTTP Mode: Implements stateful JSON - RPC, supporting full HTTP status codes and headers.

Authentication Configuration

Set authentication information through environment variables:

📚 Documentation

Project Structure

your-project-name/
├── package.json          # Project dependencies and script configurations
├── openapi.yaml         # OpenAPI specification file
├── config.js            # Server configuration
└── src/                 # Business logic code directory

Transport Mode Comparison

Starting the Server

cd your-project-name
npm install

# Standard input - output mode
npm start

# Web server mode
npm run start:web

# Streaming HTTP mode
npm run start:http

Test Client for Web Mode

1. After starting the server, open a browser and visit http://localhost:<port>.
2. Use the generated test client to interact with the MCP server.

System Requirements

• Node.js version v20 or higher.

⚠️ Important Note

This project is currently in the development phase, and there may be instability and potential issues. Please read the documentation carefully and conduct thorough tests before use.