OpenAPI 到 MCP 服务器转换器

一个用于自动将 OpenAPI 规范转换为 Model Context Protocol (MCP) 服务器实例的工具

功能特性

• 🚀 自动化转换: 自动解析 OpenAPI 3.0 规范
• 🛠 类型安全: 基于 TypeScript 的强类型验证
• 🔄 请求代理: 自动处理工具调用参数映射

快速上手

先决条件

• 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-to-mcp
├── dist/        # 编译输出目录
├── src/         # 源代码目录
│   ├── example/ # 示例配置文件
│   └── index.ts # 核心实现文件
├── package.json
└── tsconfig.json

构建命令

npm run build    # 生产环境构建
npm run watch    # 开发模式下的实时监控构建