Openapi To MCP Converter

🚀 OpenAPI 到 MCP 服務器轉換器

這是一個用於自動將 OpenAPI 規範轉換為 Model Context Protocol (MCP) 服務器實例的工具，能有效提升轉換效率與準確性。

🚀 快速開始

先決條件

• Node.js 18+
• TypeScript 5.x

安裝指南

安裝包：

npm install openapi-mcp-converter

使用示例

基礎用法

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 服務器在標準輸入輸出上運行");
}

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 許可證。