What is docfy-mcp

把你的 OpenAPI 目录暴露为编码智能体可用工具的 MCP 服务器:list_endpoints 和 get_endpoint。

它是什么

docfy-mcp 是一个 MCP(Model Context Protocol)服务器:它把一份 OpenAPI 目录(最好是已经用 nestjs-docfy 文档化过的,但任何合法的 OpenAPI 3.0/3.1 spec 都可以)暴露为接入的编码智能体可以直接调用的工具。

一共五个工具:list_endpointsget_endpoint 用于发现和查看端点,lint_spec 用于检查 spec 质量,diff_specs 用于和另一个版本比较,contract_test 用于验证正在运行的服务器是否符合 spec。

为什么需要它

没有它,一个要对接你的 API 实现客户端的智能体只有两个选择:从上下文里猜结构,或者请人打开浏览器、找到 Swagger UI,再把相关片段粘贴回对话里。这两种方式都比直接调用工具更慢,也更不可靠。

与 nestjs-docfy 如何配合

docfy-mcp 构建在与 docfy-ui 相同的文档模型引擎之上:共享的 docfy-core 包。

get_endpoint 的输出,正是 docfy-uiCopy for AI 按钮所复制的那段完全相同的文本,由同一个 operationToAiText() 函数生成。这两个项目是同一个模型的两种不同前端:一个面向浏览器里的人,一个面向通过 stdio 通信的智能体。