OpenAPI MCP 服务器

OpenAPI MCP Server 是一个基于 OpenAPI 文档快速创建 MCP 服务器的工具,实现了 StreamableHTTP 传输协议。它提供了一个标准化的 RESTful API 接口来与模型服务交互,支持 OpenAPI 3.0.0 规范的 API 文档,并具有类型安全的 TypeScript 实现。

  • by oneWalker
  • 1 星标
  • 更新于
在 GitHub 查看 oneWalker/openapi-mcp-server

使用说明

基本能力

产品定位

OpenAPI MCP Server 是一个基于 OpenAPI 文档快速创建 MCP 服务器的工具,实现了 StreamableHTTP 传输协议。

核心功能

  • 符合 OpenAPI 3.0.0 规范的 API 文档
  • 模型服务 API 文档检索
  • 带参数处理的模型服务调用
  • TypeScript 实现,确保类型安全

适用场景

  • 需要快速搭建 MCP 服务器的开发场景
  • 需要与模型服务交互的项目
  • 需要生成和管理 OpenAPI 文档的项目

工具列表

  • openapi-mcp-generator: OpenAPI 规范生成器
  • @modelcontextprotocol/sdk: MCP SDK,用于协议实现
  • express: Web 框架
  • dotenv: 环境变量管理
  • got: HTTP 客户端

使用教程

使用依赖

  • Node.js (v20 或更高版本)
  • npm (v6 或更高版本)

安装教程

  1. 克隆仓库:
git clone https://github.com/oneWalker/openapi-mcp-server.git
cd openapi-mcp-server
  1. 安装依赖:
npm install
  1. 配置环境: 在项目根目录创建 .env 文件并添加配置。
  2. 运行服务器:
npm run build
npm run start

调试方式

  • 构建项目:
npm run build
  • 开发模式运行:
npm run watch
  • 启动服务器:
npm run start