openapi-mcp-generator 的项目扩展与二次开发

项目的基础介绍

openapi-mcp-generator 是一个开源项目，旨在将 OpenAPI 规范转换为 Model Context Protocol (MCP) 服务器。该 CLI 工具自动化生成与 MCP 兼容的服务器，这些服务器可以代理请求到现有的 REST API，使得 AI 代理和其他 MCP 客户端能够无缝地使用您选择的传输方法与您的 API 交互。

项目的核心功能

• OpenAPI 3.0 支持：转换任何 OpenAPI 3.0+ 规范为 MCP 兼容服务器。
• 代理行为：代理调用原始 REST API，同时验证请求结构和安全性。
• 认证支持：通过环境变量支持 API 密钥、Bearer 令牌、基本认证和 OAuth2。
• Zod 验证：自动从 OpenAPI 定义生成 Zod 架构，以进行运行时输入验证。
• 类型化服务器：生成完全类型化、可维护的 TypeScript 代码输出。
• 多种传输方式：支持 stdio、通过 Hono 的 SSE 或 StreamableHTTP 进行通信。
• 项目脚手架：生成包含 tsconfig.json、package.json 和入口点的完整 Node.js 项目。
• 内置 HTML 测试客户端：在浏览器中测试 API 交互（针对基于 Web 的传输）。

项目使用了哪些框架或库？

• Model Context Protocol (MCP) SDK：MCP 协议实现。
• Axios：用于 API 请求的 HTTP 客户端。
• Zod：运行时验证。
• json-schema-to-zod：将 JSON Schema 转换为 Zod。
• Hono：轻量级 Web 框架，用于构建 Web 服务器和 SSE 支持。

项目的代码目录及介绍

• 根目录：包含项目的主要配置文件和脚本。
  • .gitignore：Git 忽略文件。
  • package.json：项目依赖和脚本。
  • tsconfig.json：TypeScript 配置文件。
  • README.md：项目说明文件。
• src 目录：包含项目的源代码。
  • index.ts：项目的入口文件。
  • [transport-specific-files]：特定于传输模式的文件。
• public 目录：用于 Web 服务器传输的公共文件。
  • index.html：测试客户端的 HTML 文件。

对项目进行扩展或者二次开发的方向

1. 增加新的传输模式：根据需求添加更多传输模式，例如 WebSocket 或其他实时通信协议。
2. 扩展认证支持：集成更多认证机制，如 JWT、OAuth2.0 等。
3. 优化代码生成：改进代码生成逻辑，支持更多高级特性，如异步处理、中间件支持等。
4. 增加错误处理和日志记录：提高项目的稳定性和可维护性。
5. 构建可视化配置工具：提供一个图形化界面，让用户更容易配置和生成 MCP 服务器。
6. 社区支持和文档完善：增加详细的文档和教程，鼓励社区贡献和反馈。