OpenAPI-MCP-Generator 项目:如何通过编程方式生成 MCP 工具定义
2025-06-09 09:25:37作者:管翌锬
项目概述
OpenAPI-MCP-Generator 是一个强大的工具,它能够将标准的 OpenAPI 规范转换为 MCP(Machine-Callable Procedures)工具定义。这种转换使得开发者可以更方便地将现有的 RESTful API 集成到各种自动化工作流和工具链中。
安装与基础使用
要开始使用这个工具,首先需要通过包管理器安装:
npm install openapi-mcp-generator
安装完成后,你可以通过简单的导入语句来使用核心功能:
import { getToolsFromOpenApi } from 'openapi-mcp-generator';
核心 API 详解
getToolsFromOpenApi 函数
这是该工具的核心函数,负责从 OpenAPI 规范中提取 MCP 工具定义。
函数签名:
getToolsFromOpenApi(specPathOrUrl: string, options?: Options): Promise<McpToolDefinition[]>
参数说明:
specPathOrUrl
:可以是本地 OpenAPI 规范文件的路径,也可以是远程规范的 URLoptions
:可选配置对象,用于定制提取过程
配置选项详解:
baseUrl
:覆盖 OpenAPI 规范中定义的 base URLdereference
:是否解析规范中的 $ref 引用(默认 false)excludeOperationIds
:要排除的操作 ID 数组filterFn
:自定义过滤函数,用于筛选工具定义
使用示例:
// 基本用法
const tools = await getToolsFromOpenApi('./api-spec.json');
// 带配置的高级用法
const tools = await getToolsFromOpenApi('https://example.com/api-spec.json', {
baseUrl: 'https://api.example.com/v2',
dereference: true,
excludeOperationIds: ['deprecatedOperation'],
filterFn: tool => tool.method === 'get'
});
MCP 工具定义结构解析
每个 MCP 工具定义都包含以下关键属性:
- name:工具的唯一名称
- description:人类可读的描述信息
- inputSchema:定义输入参数的 JSON Schema
- method:HTTP 方法(get/post/put/delete 等)
- pathTemplate:带有参数占位符的 URL 路径模板
- parameters:OpenAPI 参数对象数组
- executionParameters:执行时需要的参数名称和位置信息
- requestBodyContentType:请求体的内容类型(如适用)
- securityRequirements:操作的安全要求
- operationId:原始 OpenAPI 规范中的操作 ID
- baseUrl:API 的基础 URL(如可用)
高级过滤技巧
按 HTTP 方法过滤
const postTools = await getToolsFromOpenApi(specUrl, {
filterFn: tool => tool.method.toLowerCase() === 'post'
});
按安全要求过滤
const secureTools = await getToolsFromOpenApi(specUrl, {
filterFn: tool => tool.securityRequirements.length > 0
});
按路径模式过滤
const productTools = await getToolsFromOpenApi(specUrl, {
filterFn: tool => tool.pathTemplate.includes('/products')
});
组合多个过滤条件
const safeProductTools = await getToolsFromOpenApi(specUrl, {
excludeOperationIds: ['deleteProduct'],
filterFn: tool =>
tool.pathTemplate.includes('/products') &&
tool.method.toLowerCase() === 'get' &&
tool.securityRequirements.length > 0
});
实际应用场景
- 自动化工作流集成:将现有 API 快速集成到自动化工作流系统中
- API 文档生成:基于 MCP 工具定义生成更丰富的文档
- API 测试自动化:利用工具定义自动生成测试用例
- 低代码平台集成:为低代码平台提供可调用的 API 操作
最佳实践建议
- 合理使用 dereference 选项:对于复杂的规范,启用此选项可以简化处理,但会增加内存使用
- 命名规范化:考虑对生成的工具名称进行后处理,确保命名一致性
- 安全考虑:特别注意处理带有安全要求的工具定义
- 性能优化:对于大型 API 规范,考虑分批处理工具定义
通过 OpenAPI-MCP-Generator,开发者可以轻松地将现有的 RESTful API 转换为更易于程序化调用的形式,大大提高了 API 在自动化场景中的可用性和集成效率。
登录后查看全文
热门项目推荐
- DDeepSeek-V3.1-TerminusDeepSeek-V3.1-Terminus是V3的更新版,修复语言问题,并优化了代码与搜索智能体性能。Python00
- QQwen3-Omni-30B-A3B-InstructQwen3-Omni是多语言全模态模型,原生支持文本、图像、音视频输入,并实时生成语音。00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0267cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AudioFly
AudioFly is a text-to-audio generation model based on the LDM architecture. It produces high-fidelity sounds at 44.1 kHz sampling rate with strong alignment to text prompts, suitable for sound effects, music, and multi-event audio synthesis tasks.Python00- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.94 K

deepin linux kernel
C
22
6

React Native鸿蒙化仓库
C++
192
274

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
887
394

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0

本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
512