openapi-docs-mcp 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,393 +1,394 @@
1
- # OpenAPI Docs MCP
2
-
3
- 一个厂商无关的 MCP Server,帮助编码 Agent 搜索和理解 OpenAPI/Swagger 文档,且不会调用文档中描述的真实后端接口。
4
-
5
- 第一版重点保证结果确定、准确和稳定:
6
-
7
- - 启动时加载并校验本地或远程 OpenAPI 文档;
8
- - 启动完成后,所有工具调用都直接读取内存;
9
- - 使用明确的字段权重搜索中英文接口元数据;
10
- - 只在查询接口或 Schema 时按需展开本地 `$ref`;
11
- - 限制 Schema 展开深度,并检测循环引用;
12
- - 通过 stdio 暴露 4 个只读 MCP 工具;
13
- - 不绑定 OpenAI、Claude 或其他模型厂商。
14
-
15
- ## 环境要求
16
-
17
- - Node.js 20 或更高版本
18
- - 开发时建议使用 pnpm 11 或更高版本
19
-
20
- ## 快速开始
21
-
22
- 包已经发布到 npm:[openapi-docs-mcp](https://www.npmjs.com/package/openapi-docs-mcp)。
23
-
24
- ### 使用 npx(推荐)
25
-
26
- 不需要安装,直接下载并运行指定版本:
27
-
28
- ```bash
29
- npx -y openapi-docs-mcp@0.1.3 \
30
- --source https://api.example.com/v3/api-docs \
31
- --timeout 30000
32
- ```
33
-
34
- 建议在 MCP 配置中固定版本,例如 `openapi-docs-mcp@0.1.3`,避免新版本自动升级后改变行为。
35
-
36
- 如果希望始终使用最新版本:
37
-
38
- ```bash
39
- npx -y openapi-docs-mcp@latest \
40
- --source https://api.example.com/v3/api-docs
41
- ```
42
-
43
- ### 使用 pnpm dlx
44
-
45
- ```bash
46
- pnpm dlx openapi-docs-mcp@0.1.3 \
47
- --source https://api.example.com/v3/api-docs \
48
- --timeout 30000
49
- ```
50
-
51
- ### 全局安装
52
-
53
- ```bash
54
- npm install --global openapi-docs-mcp@0.1.3
55
- ```
56
-
57
- 安装后可以直接执行:
58
-
59
- ```bash
60
- openapi-docs-mcp \
61
- --source https://api.example.com/v3/api-docs \
62
- --timeout 30000
63
- ```
64
-
65
- 升级全局版本:
66
-
67
- ```bash
68
- npm install --global openapi-docs-mcp@latest
69
- ```
70
-
71
- ## 启动参数示例
72
-
73
- ### 加载本地文档
74
-
75
- 支持 OpenAPI/Swagger JSON 和 YAML 文件:
76
-
77
- ```bash
78
- npx -y openapi-docs-mcp@0.1.3 --source ./openapi.json
79
- ```
80
-
81
- 也可以直接使用位置参数:
82
-
83
- ```bash
84
- npx -y openapi-docs-mcp@0.1.3 ./openapi.yaml
85
- ```
86
-
87
- ### 加载远程文档
88
-
89
- ```bash
90
- npx -y openapi-docs-mcp@0.1.3 \
91
- --source https://api.example.com/v3/api-docs
92
- ```
93
-
94
- 默认远程加载超时时间为 10 秒,可以通过 `--timeout` 修改:
95
-
96
- ```bash
97
- npx -y openapi-docs-mcp@0.1.3 \
98
- --source https://api.example.com/v3/api-docs \
99
- --timeout 20000
100
- ```
101
-
102
- ### 加载需要鉴权的文档
103
-
104
- 可以重复使用 `--header`,格式为 `NAME=VALUE`:
105
-
106
- ```bash
107
- npx -y openapi-docs-mcp@0.1.3 \
108
- --source https://api.example.com/v3/api-docs \
109
- --header Authorization="Bearer token" \
110
- --header X-Tenant-Id=tenant-1
111
- ```
112
-
113
- 日志和错误信息只会写入 stderr,stdout 专门用于传输 MCP 消息。
114
-
115
- ## CLI 参数
116
-
117
- ```text
118
- 用法:openapi-docs-mcp --source <文件或URL> [选项]
119
-
120
- 选项:
121
- -s, --source <value> OpenAPI JSON/YAML 文件或 HTTP(S) URL
122
- --header NAME=VALUE 加载远程文档时使用的请求头,可重复传入
123
- --timeout <ms> 远程加载超时时间,默认 10000 毫秒
124
- --strict-validation 严格模式:任何 OpenAPI 校验警告都会阻止启动
125
- -h, --help 显示帮助信息
126
- ```
127
-
128
- ## MCP Client 配置
129
-
130
- 可以在任意支持 stdio MCP Server 的 Client 中通过 `npx` 启动,无需克隆或构建本项目:
131
-
132
- ```json
133
- {
134
- "mcpServers": {
135
- "project-api-docs": {
136
- "command": "npx",
137
- "args": [
138
- "-y",
139
- "openapi-docs-mcp@0.1.3",
140
- "--source",
141
- "https://api.example.com/v3/api-docs",
142
- "--timeout",
143
- "30000"
144
- ]
145
- }
146
- }
147
- }
148
- ```
149
-
150
- ### VS Code + mise 兼容配置
151
-
152
- VS Code 使用顶层字段 `servers`。如果 VS Code 扩展宿主误用了旧版 Node.js 或旧版 `npx`,可能出现 `ERROR: You must supply a command.`。此时可以让 VS Code 通过 `mise` 固定使用 Node.js 24,再启动本包:
153
-
154
- ```json
155
- {
156
- "servers": {
157
- "project-api-docs": {
158
- "type": "stdio",
159
- "command": "mise",
160
- "args": [
161
- "exec",
162
- "node@24",
163
- "--",
164
- "npx",
165
- "--yes",
166
- "openapi-docs-mcp@0.1.3",
167
- "--source",
168
- "https://api.example.com/v3/api-docs",
169
- "--timeout",
170
- "30000"
171
- ]
172
- }
173
- }
174
- }
175
- ```
176
-
177
- 在终端执行 `where.exe mise` 可以查看本机 `mise.exe` 的实际路径,并替换示例中的 `command`。配置步骤:
178
-
179
- 1. 在 VS Code 中按 `Ctrl + Shift + P`;
180
- 2. 执行 `MCP: Open User Configuration`;
181
- 3. 写入上述配置并替换 OpenAPI 地址;
182
- 4. 执行 `MCP: List Servers`,启动或重启 `project-api-docs`。
183
-
184
- 推荐将包含内部 OpenAPI 地址或鉴权信息的配置放在 VS Code 用户配置中,不要提交到项目仓库。MCP 使用 stdio 通信,由 VS Code 负责启动进程,不需要提前在终端中常驻运行命令。
185
-
186
- 同一个 npm 包可以使用不同 OpenAPI 文档启动多个实例,因此不同项目之间不会冲突。
187
-
188
- ### 同时配置多个实例
189
-
190
- 每个实例使用不同的 MCP Server 名称和 `--source`:
191
-
192
- ```json
193
- {
194
- "mcpServers": {
195
- "safety-api-docs": {
196
- "command": "npx",
197
- "args": [
198
- "-y",
199
- "openapi-docs-mcp@0.1.3",
200
- "--source",
201
- "https://safety.example.com/v3/api-docs",
202
- "--timeout",
203
- "30000"
204
- ]
205
- },
206
- "mall-api-docs": {
207
- "command": "npx",
208
- "args": [
209
- "-y",
210
- "openapi-docs-mcp@0.1.3",
211
- "--source",
212
- "https://mall.example.com/v3/api-docs",
213
- "--timeout",
214
- "30000"
215
- ]
216
- }
217
- }
218
- }
219
- ```
220
-
221
- ### 使用本地源码构建
222
-
223
- 参与开发时才需要克隆源码并构建:
224
-
225
- ```bash
226
- pnpm install
227
- pnpm build
228
- node dist/cli.js --source ./openapi.json
229
- ```
230
-
231
- 本地 MCP 配置需要使用 `dist/cli.js` 的绝对路径:
232
-
233
- ```json
234
- {
235
- "mcpServers": {
236
- "local-api-docs": {
237
- "command": "node",
238
- "args": [
239
- "C:/absolute/path/openapi-docs-mcp/dist/cli.js",
240
- "--source",
241
- "C:/absolute/path/openapi.json"
242
- ]
243
- }
244
- }
245
- }
246
- ```
247
-
248
- ## MCP 工具
249
-
250
- ### `search_api`
251
-
252
- 根据自然语言关键词、路径、标签、描述或 `operationId` 搜索接口,返回经过排序的轻量候选结果。
253
-
254
- 正常工作流是先调用 `search_api` 找到接口,再把结果中的 `id` 传给 `get_api`。
255
-
256
- 输入参数:
257
-
258
- | 参数 | 必填 | 说明 |
259
- | -------- | ---: | ------------------------------------------------ |
260
- | `query` | | 搜索关键词,例如 `异常分页列表` 或 `create user` |
261
- | `method` | | HTTP 方法过滤条件,例如 `GET`、`POST` |
262
- | `tag` | 否 | 精确匹配 OpenAPI Tag |
263
- | `limit` | 否 | 返回数量,默认 10,最大 50 |
264
-
265
- 搜索字段权重:
266
-
267
- | 字段 | 权重 |
268
- | ------------- | ---: |
269
- | `summary` | 10 |
270
- | `tags` | 8 |
271
- | `path` | 6 |
272
- | `description` | 4 |
273
- | `operationId` | 2 |
274
-
275
- 中文搜索不依赖空格分词,会使用标准化、包含匹配以及二元/三元字符片段进行评分。
276
-
277
- ### `get_api`
278
-
279
- 获取单个接口的完整上下文,包括:
280
-
281
- - HTTP 方法和路径;
282
- - Summary、Description 和 Tags;
283
- - Path、Query、Header、Cookie 参数;
284
- - Request Body 和 Content-Type;
285
- - Responses;
286
- - Security 和 Deprecated 元数据;
287
- - 按需展开后的 Schema。
288
-
289
- 优先传入 `search_api` 返回的 `id`,也可以传入精确的 `path` 和可选的 `method`。
290
-
291
- `maxDepth` 用于控制 Schema 最大展开深度,默认值为 5,允许范围为 1 到 12。
292
-
293
- ### `get_schema`
294
-
295
- 根据精确名称读取 `components.schemas` 中的 Schema。
296
-
297
- 本地 `$ref` 会按需展开,同时具有:
298
-
299
- - 最大深度限制;
300
- - 最大属性数量限制;
301
- - 循环引用检测;
302
- - 无法解析的引用标记。
303
-
304
- ### `list_groups`
305
-
306
- 列出 OpenAPI Tags 及每个 Tag 下的接口数量。
307
-
308
- 没有 Tag 的接口会归入 `untagged`。
309
-
310
- ## 推荐调用流程
311
-
312
- ```text
313
- 用户描述需要实现的功能
314
-
315
- search_api 搜索候选接口
316
-
317
- 根据 summary、tag、path 选择接口
318
-
319
- get_api 一次获取请求和响应结构
320
-
321
- 必要时再调用 get_schema
322
-
323
- 生成 TypeScript 类型、API 方法和页面调用代码
324
- ```
325
-
326
- ## 开发与测试
327
-
328
- ```bash
329
- pnpm typecheck
330
- pnpm test
331
- pnpm build
332
- ```
333
-
334
- 当前测试覆盖:
335
-
336
- - OpenAPI 3.0 文档加载;
337
- - OpenAPI 3.1 YAML 文档加载;
338
- - Swagger 2.0 文档加载;
339
- - 无效文档错误处理;
340
- - 中文加权搜索;
341
- - Method 和 Tag 过滤;
342
- - 接口请求与响应 Schema 展开;
343
- - 循环引用保护;
344
- - MCP 工具发现与调用。
345
-
346
- ## 当前版本边界
347
-
348
- 第一版有意保持较小的功能范围。
349
-
350
- 已经支持:
351
-
352
- - OpenAPI 3.0、3.1;
353
- - Swagger 2.0;
354
- - JSON 和 YAML;
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/yangjh0127/openapi-docs-mcp/main/assets/openapi-docs-mcp-logo.png" alt="OpenAPI Docs MCP" width="760">
3
+ </p>
4
+
5
+ # OpenAPI Docs MCP
6
+
7
+ > 让编码 Agent 安全、准确地搜索和理解 OpenAPI / Swagger 文档。
8
+
9
+ [![npm version](https://img.shields.io/npm/v/openapi-docs-mcp?label=npm)](https://www.npmjs.com/package/openapi-docs-mcp)
10
+ ![Node.js](https://img.shields.io/badge/Node.js-%3E%3D20-339933?logo=node.js&logoColor=white)
11
+ ![License](https://img.shields.io/badge/license-MIT-blue)
12
+
13
+ **快速导航:** [名称](#名称) · [简介](#简介) · [详细描述](#详细描述) · [项目状态](#项目状态) · [使用方法](#使用方法)
14
+
15
+ ---
16
+
17
+ ## 名称
18
+
19
+ **OpenAPI Docs MCP**
20
+
21
+ npm 包:[`openapi-docs-mcp`](https://www.npmjs.com/package/openapi-docs-mcp)
22
+
23
+ ## 简介
24
+
25
+ 一个厂商无关的 MCP Server,让编码 Agent 能够搜索和理解 OpenAPI/Swagger 文档。
26
+
27
+ 服务只读取接口文档,不会调用文档中描述的真实后端 API。它支持本地文件和远程地址,启动后使用内存索引提供稳定、快速的查询。
28
+
29
+ ## 详细描述
30
+
31
+ OpenAPI Docs MCP 支持 OpenAPI 3.0、3.1 和 Swagger 2.0,可读取 JSON、YAML、本地文件及 HTTP(S) URL。
32
+
33
+ 它提供 5 个 MCP 工具:
34
+
35
+ | 工具 | 作用 |
36
+ | :--- | :--- |
37
+ | `search_api` | 按关键词、路径、Tag、描述或 `operationId` 搜索接口 |
38
+ | `get_api` | 获取接口参数、请求体、响应和展开后的 Schema |
39
+ | `get_schema` | 按名称读取组件 Schema |
40
+ | `list_groups` | 列出 OpenAPI Tags 及接口数量 |
41
+ | `reload_document` | 重新加载文档,无需重启 MCP Server |
42
+
43
+ ### 核心能力
44
+
45
+ - 支持中英文接口搜索,并对 Summary、Tag、Path 等字段进行确定性加权;
46
+ - 按需展开本地 `$ref`,限制最大深度和属性数量;
47
+ - 检测循环引用,并标记无法解析的引用;
48
+ - 兼容模式可保守修复确定可解析的脏 `$ref`,并报告修复、跳过和校验诊断;
49
+ - 远程文档支持自定义请求头和超时;
50
+ - 刷新失败时保留旧文档,不影响现有查询;
51
+ - 通过 stdio 工作,可接入任意兼容 MCP 的 Agent 或 IDE。
52
+
53
+ ## 项目状态
54
+
55
+ | 项目 | 状态 |
56
+ | :--- | :--- |
57
+ | 当前版本 | `0.1.5` |
58
+ | 运行环境 | Node.js 20+ |
59
+ | 项目阶段 | 可用的早期版本 |
60
+ | 传输方式 | stdio |
61
+ | 许可证 | MIT |
62
+
63
+ > **说明:** 当前暂不支持外部文件或 URL `$ref`、向量搜索、Streamable HTTP 部署以及真实后端 API 调用。
64
+
65
+ ## 使用方法
66
+
67
+ ### 方式一:通过 npx 运行(推荐)
68
+
69
+ 无需安装或克隆项目,直接在 MCP Client 中启动:
70
+
71
+ ```json
72
+ {
73
+ "mcpServers": {
74
+ "project-api-docs": {
75
+ "command": "npx",
76
+ "args": [
77
+ "-y",
78
+ "openapi-docs-mcp@0.1.5",
79
+ "--source",
80
+ "https://api.example.com/v3/api-docs",
81
+ "--timeout",
82
+ "30000"
83
+ ]
84
+ }
85
+ }
86
+ }
87
+ ```
88
+
89
+ ### 方式二:全局安装
90
+
91
+ 安装后可以直接使用 `openapi-docs-mcp` 命令:
92
+
93
+ ```bash
94
+ npm install --global openapi-docs-mcp@0.1.5
95
+ openapi-docs-mcp --source https://api.example.com/v3/api-docs --timeout 30000
96
+ ```
97
+
98
+ 对应的 MCP Client 配置:
99
+
100
+ ```json
101
+ {
102
+ "mcpServers": {
103
+ "project-api-docs": {
104
+ "command": "openapi-docs-mcp",
105
+ "args": [
106
+ "--source",
107
+ "https://api.example.com/v3/api-docs",
108
+ "--timeout",
109
+ "30000"
110
+ ]
111
+ }
112
+ }
113
+ }
114
+ ```
115
+
116
+ ### 方式三:通过 mise 固定 Node.js
117
+
118
+ 如果 MCP Client 使用了不兼容的 Node.js 或 `npx`,可以通过 mise 固定运行时版本:
119
+
120
+ ```bash
121
+ mise exec node@24 -- npx --yes openapi-docs-mcp@0.1.5 \
122
+ --source https://api.example.com/v3/api-docs \
123
+ --timeout 30000
124
+ ```
125
+
126
+ 在 MCP Client 中,将 `mise` 作为启动命令:
127
+
128
+ ```json
129
+ {
130
+ "mcpServers": {
131
+ "project-api-docs": {
132
+ "command": "mise",
133
+ "args": [
134
+ "exec",
135
+ "node@24",
136
+ "--",
137
+ "npx",
138
+ "--yes",
139
+ "openapi-docs-mcp@0.1.5",
140
+ "--source",
141
+ "https://api.example.com/v3/api-docs",
142
+ "--timeout",
143
+ "30000"
144
+ ]
145
+ }
146
+ }
147
+ }
148
+ ```
149
+
150
+ > **提示:** 不同 MCP Client 的外层配置字段可能是 `mcpServers`、`servers` 或其他名称,但 `command` 和 `args` 的内容相同。如果客户端找不到 `mise`,可通过 Windows 的 `where.exe mise` 或 macOS/Linux 的 `which mise` 查询路径,并将 `command` 替换为绝对路径。
151
+
152
+ ### 方式四:同时连接多个项目
153
+
154
+ 为每份 OpenAPI 文档配置一个独立的 MCP 实例:
155
+
156
+ ```json
157
+ {
158
+ "mcpServers": {
159
+ "order-api-docs": {
160
+ "command": "npx",
161
+ "args": [
162
+ "-y",
163
+ "openapi-docs-mcp@0.1.5",
164
+ "--source",
165
+ "https://order.example.com/v3/api-docs"
166
+ ]
167
+ },
168
+ "user-api-docs": {
169
+ "command": "npx",
170
+ "args": [
171
+ "-y",
172
+ "openapi-docs-mcp@0.1.5",
173
+ "--source",
174
+ "https://user.example.com/v3/api-docs"
175
+ ]
176
+ }
177
+ }
178
+ }
179
+ ```
180
+
181
+ 每个实例单独加载和刷新自己的文档,互不影响。
182
+
183
+ ### 更多启动示例
184
+
185
+ **读取本地文档**
186
+
187
+ ```bash
188
+ npx -y openapi-docs-mcp@0.1.5 --source ./openapi.yaml
189
+ ```
190
+
191
+ **读取需要鉴权的远程文档**
192
+
193
+ ```bash
194
+ npx -y openapi-docs-mcp@0.1.5 \
195
+ --source https://api.example.com/v3/api-docs \
196
+ --header Authorization="Bearer token" \
197
+ --header X-Tenant-Id=tenant-1 \
198
+ --timeout 30000
199
+ ```
200
+
201
+ ### CLI 参数
202
+
203
+ | 参数 | 说明 |
204
+ | :--- | :--- |
205
+ | `-s, --source <value>` | OpenAPI 文件或 HTTP(S) URL,必填 |
206
+ | `--header NAME=VALUE` | 远程文档请求头,可重复使用 |
207
+ | `--timeout <ms>` | 远程加载超时,默认 10000 毫秒 |
208
+ | `--strict-validation` | 将所有 OpenAPI 校验警告视为错误 |
209
+ | `-h, --help` | 显示帮助 |
210
+
211
+ ### 本地开发
212
+
213
+ ```bash
214
+ pnpm install
215
+ pnpm test
216
+ pnpm build
217
+ node dist/cli.js --source ./openapi.json
218
+ ```
219
+ <<<<<<< HEAD
220
+
221
+ 本地 MCP 配置需要使用 `dist/cli.js` 的绝对路径:
222
+
223
+ ```json
224
+ {
225
+ "mcpServers": {
226
+ "local-api-docs": {
227
+ "command": "node",
228
+ "args": [
229
+ "C:/absolute/path/openapi-docs-mcp/dist/cli.js",
230
+ "--source",
231
+ "C:/absolute/path/openapi.json"
232
+ ]
233
+ }
234
+ }
235
+ }
236
+ ```
237
+
238
+ ## MCP 工具
239
+
240
+ ### `search_api`
241
+
242
+ 根据自然语言关键词、路径、标签、描述或 `operationId` 搜索接口,返回经过排序的轻量候选结果。
243
+
244
+ 正常工作流是先调用 `search_api` 找到接口,再把结果中的 `id` 传给 `get_api`。
245
+
246
+ 输入参数:
247
+
248
+ | 参数 | 必填 | 说明 |
249
+ | -------- | ---: | ------------------------------------------------ |
250
+ | `query` | 否 | 搜索关键词,例如 `异常分页列表` 或 `create user` |
251
+ | `method` | 否 | HTTP 方法过滤条件,例如 `GET`、`POST` |
252
+ | `tag` | 否 | 精确匹配 OpenAPI Tag |
253
+ | `limit` | 否 | 返回数量,默认 10,最大 50 |
254
+
255
+ 搜索字段权重:
256
+
257
+ | 字段 | 权重 |
258
+ | ------------- | ---: |
259
+ | `summary` | 10 |
260
+ | `tags` | 8 |
261
+ | `path` | 6 |
262
+ | `description` | 4 |
263
+ | `operationId` | 2 |
264
+
265
+ 中文搜索不依赖空格分词,会使用标准化、包含匹配以及二元/三元字符片段进行评分。
266
+
267
+ ### `get_api`
268
+
269
+ 获取单个接口的完整上下文,包括:
270
+
271
+ - HTTP 方法和路径;
272
+ - Summary、Description Tags;
273
+ - Path、Query、Header、Cookie 参数;
274
+ - Request Body 和 Content-Type;
275
+ - Responses;
276
+ - Security 和 Deprecated 元数据;
277
+ - 按需展开后的 Schema。
278
+
279
+ 优先传入 `search_api` 返回的 `id`,也可以传入精确的 `path` 和可选的 `method`。
280
+
281
+ `maxDepth` 用于控制 Schema 最大展开深度,默认值为 5,允许范围为 1 到 12。
282
+
283
+ ### `get_schema`
284
+
285
+ 根据精确名称读取 `components.schemas` 中的 Schema。
286
+
287
+ 本地 `$ref` 会按需展开,同时具有:
288
+
289
+ - 最大深度限制;
290
+ - 最大属性数量限制;
291
+ - 循环引用检测;
292
+ - 无法解析的引用标记。
293
+
294
+ ### `list_groups`
295
+
296
+ 列出 OpenAPI Tags 及每个 Tag 下的接口数量。
297
+
298
+ 没有 Tag 的接口会归入 `untagged`。
299
+
300
+ ## 推荐调用流程
301
+
302
+ ```text
303
+ 用户描述需要实现的功能
304
+
305
+ search_api 搜索候选接口
306
+
307
+ 根据 summary、tag、path 选择接口
308
+
309
+ get_api 一次获取请求和响应结构
310
+
311
+ 必要时再调用 get_schema
312
+
313
+ 生成 TypeScript 类型、API 方法和页面调用代码
314
+ ```
315
+
316
+ ## 开发与测试
317
+
318
+ ```bash
319
+ pnpm typecheck
320
+ pnpm test
321
+ pnpm build
322
+ ```
323
+
324
+ 当前测试覆盖:
325
+
326
+ - OpenAPI 3.0 文档加载;
327
+ - OpenAPI 3.1 YAML 文档加载;
328
+ - Swagger 2.0 文档加载;
329
+ - 无效文档错误处理;
330
+ - 中文加权搜索;
331
+ - Method 和 Tag 过滤;
332
+ - 接口请求与响应 Schema 展开;
333
+ - 循环引用保护;
334
+ - MCP 工具发现与调用。
335
+
336
+ ## 当前版本边界
337
+
338
+ 第一版有意保持较小的功能范围。
339
+
340
+ 已经支持:
341
+
342
+ - OpenAPI 3.0、3.1;
343
+ - Swagger 2.0;
344
+ - JSON 和 YAML;
355
345
  - 本地文件和 HTTP(S) URL;
356
346
  - 本地 `$ref` 按需展开;
347
+ - 通过 `reload_document` 手动重新加载文档;
357
348
  - stdio MCP 传输。
358
-
359
- 暂不支持:
360
-
361
- - 调用真实后端 API;
362
- - 保存或管理后端鉴权凭证;
363
- - 展开其他文件或 URL 中的外部 `$ref`;
364
- - 向量数据库或 Embedding 搜索;
365
- - Streamable HTTP MCP 部署;
366
- - OpenAPI 文档自动刷新;
367
- - 模型厂商私有能力。
368
-
369
- 当 OpenAPI 文档发生变化时,重启 MCP Server 即可重新加载和建立索引。
370
-
371
- ## 设计原则
372
-
373
- ```text
374
- OpenAPI / Swagger
375
-
376
- 加载与校验
377
-
378
- 标准 OpenAPI Document
379
-
380
- 内存 Operation 索引
381
-
382
- Search + Formatter
383
-
384
- 标准 MCP Tools
385
-
386
- 任意支持 MCP 的 Agent 或 IDE
387
- ```
388
-
389
- 项目不会把 OpenAPI 数据重新转换成一套重复的核心模型。OpenAPI Document 始终是事实来源,自定义类型只用于搜索结果和 MCP 输出。
390
-
391
- Formatter 也不会擅自修复后端文档中的可疑定义,而是忠实返回 OpenAPI 声明的内容,避免工具本身成为新的错误来源。
392
-
393
- 默认使用兼容校验模式。部分 Springdoc 文档会生成包含中文名称的本地 `$ref`;严格的 URI 校验器可能拒绝这类引用。只要引用目标真实存在,本项目会保留警告并继续加载。需要完全遵循严格校验结果时,可以添加 `--strict-validation`。
349
+
350
+ 暂不支持:
351
+
352
+ - 调用真实后端 API;
353
+ - 保存或管理后端鉴权凭证;
354
+ - 展开其他文件或 URL 中的外部 `$ref`;
355
+ - 向量数据库或 Embedding 搜索;
356
+ - Streamable HTTP MCP 部署;
357
+ - OpenAPI 文档自动轮询或文件监听;
358
+ - 模型厂商私有能力。
359
+
360
+ 当 OpenAPI 文档发生变化时,可以调用 `reload_document` 重新加载;也可以重启 MCP Server
361
+
362
+ ## 设计原则
363
+
364
+ ```text
365
+ OpenAPI / Swagger
366
+
367
+ 解析、保守归一化与校验
368
+
369
+ 标准 OpenAPI Document
370
+
371
+ 内存 Operation 索引
372
+
373
+ Search + Formatter
374
+
375
+ 标准 MCP Tools
376
+
377
+ 任意支持 MCP 的 Agent 或 IDE
378
+ ```
379
+
380
+ 项目不会把 OpenAPI 数据重新转换成一套重复的核心模型。OpenAPI Document 始终是事实来源,自定义类型只用于搜索结果和 MCP 输出。
381
+
382
+ Formatter 不会改写已经加载的 OpenAPI 声明。兼容模式只在加载阶段修复能够唯一确定目标的局部缺陷,避免工具凭相似度猜测后端含义。
383
+
384
+ 默认使用兼容校验模式。部分 Springdoc 文档会生成包含中文名称、缺少本地前缀或未转义 JSON Pointer 字符的 `$ref`。只要引用目标能够唯一确定,项目会修复内存副本并输出诊断;不会修改源文件。
385
+
386
+ ### 兼容模式诊断
387
+
388
+ 兼容模式会跳过无法表示为对象的 path item 或 operation,并为缺少 `responses` 的 operation 补充空对象。每一次修复、跳过、未解析引用或歧义引用都会通过 stderr 输出有界摘要,不会污染 MCP 使用的 stdout。
389
+
390
+ 未解析或存在多个精确候选的引用会保持原值,项目不会进行模糊、忽略大小写或裁剪空白后的匹配,也不会加载外部 URL 或文件引用。只有无法解析文档、缺少顶层版本、`info` 或 `paths` 等整体不可用情况才会阻止兼容模式启动。
391
+
392
+ 需要禁用所有修复并让任意 OpenAPI 校验错误阻止启动时,可添加 `--strict-validation`。
393
+ =======
394
+ >>>>>>> a3b93fdd98548eef1c651dab869bc76ce05e0938