Openapi MCP Generator

🚀 OpenAPI 轉 MCP 服務器生成工具

本工具是一款命令行工具，可將 OpenAPI 規範轉換為 Model Context Protocol (MCP) 兼容服務器，為開發者提供便捷的服務器生成方案。

🚀 快速開始

安裝

npm install -g @your-package-name

基本使用步驟

1. 初始化項目：

mcp-server init your-project-name

2. 根據提示完成 OpenAPI 配置文件的填寫。
3. 啟動服務器：

cd your-project-name
npm start

✨ 主要特性

• OpenAPI 支持：支持 OpenAPI 3.0 標準，能夠解析並生成 MCP 服務器。
• 代理行為：實現請求轉發功能，支持多種認證方式。
• 認證支持：涵蓋 API Key、Bearer Token、Basic Auth 和 OAuth2 等多種身份驗證方案。
• Zod 驗證：使用 Zod 進行數據驗證，確保輸入輸出的合法性。
• 多種傳輸模式：支持標準輸入輸出（stdio）、基於 SSE 的 Web 服務器和流式 HTTP 傳輸。

📦 安裝指南

使用以下命令進行全局安裝：

npm install -g @your-package-name

💻 使用示例

基礎用法

1. 初始化項目：

mcp-server init your-project-name

2. 按提示填寫 OpenAPI 配置文件。
3. 啟動服務器：

cd your-project-name
npm start

高級用法

傳輸模式選擇

• stdio 模式：適用於本地開發和集成到 LLM 工具中。
• Web 服務器（SSE）：提供基於 SSE 的雙向消息通信，支持多連接和瀏覽器客戶端。
• 流式 HTTP 模式：實現狀態ful JSON - RPC，支持完整 HTTP 狀態碼和頭信息。

認證配置

通過環境變量設置認證信息：

📚 詳細文檔

項目結構

your-project-name/
├── package.json          # 項目依賴和腳本配置
├── openapi.yaml         # OpenAPI 規範文件
├── config.js            # 服務器配置
└── src/                 # 業務邏輯代碼目錄

傳輸模式對比

啟動服務器

cd your-project-name
npm install

# 標準輸入輸出模式
npm start

# Web 服務器模式
npm run start:web

# 流式 HTTP 模式
npm run start:http

Web 模式的測試客戶端

1. 啟動服務器後，打開瀏覽器訪問 http://localhost:<port>。
2. 使用生成的測試客戶端與 MCP 服務器進行交互。

📄 系統要求

• Node.js 版本 v20 或更高版本。

⚠️ 重要提示

該項目目前處於開發階段，可能存在不穩定性和潛在問題。使用前請仔細閱讀文檔並做好充分測試。