使用说明
基本能力
产品定位
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 或更高版本)
安装教程
- 克隆仓库:
git clone https://github.com/oneWalker/openapi-mcp-server.git
cd openapi-mcp-server
- 安装依赖:
npm install
- 配置环境:
在项目根目录创建
.env文件并添加配置。 - 运行服务器:
npm run build
npm run start
调试方式
- 构建项目:
npm run build
- 开发模式运行:
npm run watch
- 启动服务器:
npm run start