Openapi MCP Converter

🚀 OpenAPI 到 MCP 服務器轉換器

一個用於自動將 OpenAPI 規範轉換為 Model Context Protocol (MCP) 服務器實例的工具，能夠大大提升開發效率，節省手動轉換的時間和精力。

🚀 快速開始

先決條件

• Node.js 18+ 版本
• TypeScript 5.x 版本

基本使用方法

安裝包：

npm install openapi-mcp-converter

運行本地標準輸入輸出（stdio）MCP 服務器：

import fs from 'fs';
import { OpenApiMCPSeverConverter } from '../index.js';
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
import path from 'path';
import { fileURLToPath } from 'url';

const openApiDoc = JSON.parse(fs.readFileSync(path.join(path.dirname(fileURLToPath(import.meta.url)), 'openapi.json'), 'utf8'));

const converter = new OpenApiMCPSeverConverter(openApiDoc, { timeout: 100000 });
const server = converter.getServer();
console.log(JSON.stringify(converter.getMcpTools(), null, 2));
console.log(JSON.stringify(converter.getTools(), null, 2));
async function runServer() {
  const transport = new StdioServerTransport();
  await server.connect(transport);
  console.log("GitHub MCP Server 運行在 stdio");
}

runServer().catch((error) => {
  console.error("主程序中的致命錯誤:", error);
  process.exit(1);
});

運行示例

npm run test    # 執行示例測試用例

✨ 主要特性

• 🚀 自動化轉換：自動解析 OpenAPI 3.0 規範，無需手動處理複雜的轉換流程。
• 🛠 類型安全：基於 TypeScript 的強類型驗證，減少運行時錯誤。
• 🔄 請求代理：自動處理工具調用參數映射，簡化開發過程。

📚 詳細文檔

項目結構

/openapi-to-mcp
├── dist/        # 編譯輸出目錄
├── src/         # 源代碼目錄
│   ├── example/ # 示例配置文件
│   └── index.ts # 核心實現文件
├── package.json
└── tsconfig.json

構建命令

npm run build    # 生產環境構建
npm run watch    # 開發模式下的即時監控構建

📄 許可證

本項目採用 MIT 許可證。