@szc-ft/mcp-szcd-client 0.24.0 → 0.25.0

package/qwen-extension/skills/local-api-tool/SKILL.md

@@ -1,11 +1,14 @@
 ---
 name: local-api-tool
-description: 本地网络 API 工具，专门处理 10.x.x.x 网段的 Swagger/YApi 文档拉取和联调测试。当服务端 api_tool 因 LOCAL_NETWORK_UNREACHABLE 无法访问时，此技能在用户本地环境执行 curl，再将结果交给服务端解析。适用于内网开发环境、VPN 场景。**仅限 10.x.x.x 网段**，172.16-31.x.x 和 192.168.x.x 服务端可直连，不要使用本技能。
+description: 本地网络 API 工具，专门处理 10.x.x.x 网段的 Swagger/YApi 文档拉取和联调测试。内置 scripts/extract_swagger.py 一步完成"下载→解析→按 tag 过滤→关联 DTO definitions→输出"，与服务端 parseApiDocs 一比一对齐（递归深度 5、两层 definitions、传递闭包裁剪），避免 curl 管道截断和手写花括号平衡脚本的弯路。仅当脚本不可用时回退到服务端 parse_swagger_json 兜底。**仅限 10.x.x.x 网段**，172.16-31.x.x 和 192.168.x.x 服务端可直连，不要使用本技能。
 compatibility:
   tools:
     - run_command
     - web_search
     - web_fetch
+  runtime:
+    - python3 >= 3.7
+    - curl
 ---
 
 # 本地网络 API 工具（local-api-tool）
@@ -37,25 +40,50 @@ compatibility:
 
 ### 流程 A：拉取 Swagger API 文档（fetch）
 
+> **优先使用内置脚本 `scripts/extract_swagger.py`**，一步完成"下载 → 解析 → 过滤 → 关联 DTO → 输出"，避免 curl 管道截断、临时脚本花括号平衡等弯路。脚本与服务端 `parseApiDocs` 一比一对齐（递归深度 5、两层 definitions、传递闭包裁剪）。
+> 仅当脚本不可用（无 python3 / 文件权限缺失）时才回退到「手工 curl + 服务端 parse_swagger_json」兜底流程。
+
+#### A1. 内置脚本路径（首选）
+
 ```
 用户请求 fetch Swagger URL (10.x.x.x)
     │
     ▼
-调用 api_tool(action="fetch", url=...)
+AI 识别 10.x.x.x 网段（或服务端返回 LOCAL_NETWORK_UNREACHABLE）
+    │
+    ▼
+通过 run_command 在本地执行：
+  bash $SKILL_DIR/scripts/extract_swagger.py \
+      --url <apiDocsUrl> [--cookie '...'] [--filter <关键词>] [--out /tmp/parsed.json]
     │
     ▼
-服务端返回 { reason: "LOCAL_NETWORK_UNREACHABLE", action: "请使用 local-api-tool ...", swaggerEndpoints: {...} }
+脚本内部：curl 下载 → 解析 → 过滤 paths → 自动展开被引用 DTO → 输出 JSON
+    │
+    ▼
+AI 读取脚本输出（或 --out 指定的文件），结构与 api_tool(parse_swagger_json) 完全一致：
+  { info, basePath, tags, apis, definitions, definitionsDetail, _filter? }
+```
+
+**$SKILL_DIR 是本 skill 的绝对目录**。在 qwen/qoder 中 skill 加载时通常通过环境变量或上下文提供，若不确定可用：
+- qwen-extension: `~/.qwen/extensions/szcd-component-helper/skills/local-api-tool/scripts/extract_swagger.py`
+- opencode-extension: `~/.config/opencode/extensions/szcd-component-helper/skills/local-api-tool/scripts/extract_swagger.py`
+
+#### A2. 服务端兜底（脚本不可用时）
+
+```
+调用 api_tool(action="fetch", url=...)
     │
     ▼
-AI 识别 LOCAL_NETWORK_UNREACHABLE，读取 swaggerEndpoints 和 authInfo
+服务端返回 { reason: "LOCAL_NETWORK_UNREACHABLE", swaggerEndpoints, authInfo }
     │
     ▼
-AI 通过 run_command 在本地执行 curl：
+AI 通过 run_command 在本地 curl 写到临时文件（禁止管道截断！）：
   步骤1: 鉴权获取 Cookie（如 authInfo.hasPassword 为 true）
-  步骤2: 获取完整 API 文档 JSON
+  步骤2: curl -o /tmp/swagger.json <apiDocsUrl>      ← 必须写文件
     │
     ▼
-AI 调用 api_tool(action="parse_swagger_json", swaggerJson=..., swaggerSourceUrl=...)
+AI 读取整个文件传给服务端：
+  api_tool(action="parse_swagger_json", swaggerJson=<完整 JSON 字符串>, apiFilter=<可选>)
     │
     ▼
 返回解析后的 API 文档给用户
@@ -84,7 +112,97 @@ AI 通过 run_command 在本地执行对应 curl 命令
 
 ## 详细执行步骤
 
-### 一、拉取 Swagger 文档（action=fetch）
+### 一、拉取 Swagger 文档（推荐路径：extract_swagger.py）
+
+**前提**：本地有 python3（≥ 3.7）和 curl。脚本只依赖标准库，无第三方依赖。
+
+#### 1.1 直接通过 URL 下载并解析（推荐）
+
+```bash
+# 无鉴权
+python3 ~/.qwen/extensions/szcd-component-helper/skills/local-api-tool/scripts/extract_swagger.py \
+  --url 'http://10.2.7.60:30194/ikmp-knowledge/v2/api-docs' \
+  --out /tmp/parsed.json
+
+# 有鉴权（先单独 curl 拿 Cookie，参考下方 1.3）
+python3 .../extract_swagger.py \
+  --url 'http://10.2.7.60:30194/ikmp-knowledge/v2/api-docs' \
+  --cookie 'JSESSIONID=xxx' \
+  --out /tmp/parsed.json
+
+# 按关键词过滤 + 自动裁剪 definitionsDetail（仅保留被引用的 VO 及传递闭包）
+python3 .../extract_swagger.py \
+  --url '<apiDocsUrl>' \
+  --filter tag --filter user \
+  --out /tmp/parsed.json
+```
+
+#### 1.2 读取已下载的本地 JSON 文件
+
+```bash
+# 第一步：curl 写文件（务必用 -o 写文件，不要用管道，避免大 JSON 被截断）
+curl -sS --connect-timeout 10 --max-time 30 \
+  -H 'Accept: application/json' \
+  -H 'Cookie: <Cookie>' \
+  -o /tmp/swagger-raw.json \
+  'http://10.2.7.60:30194/ikmp-knowledge/v2/api-docs'
+
+# 第二步：交给脚本解析
+python3 .../extract_swagger.py --file /tmp/swagger-raw.json --filter tag --out /tmp/parsed.json
+```
+
+#### 1.3 鉴权（如需 Cookie）
+
+```bash
+# 取 Cookie（注意 -D - 把响应头打到 stdout）
+curl -sS -D - -X GET 'http://10.2.7.60:30194/ikmp-knowledge/swagger-resources/configuration/ui' \
+  -H 'Authorization: Basic <base64(username:password)>' \
+  -H 'Accept: application/json' \
+  -o /dev/null \
+  | grep -i '^set-cookie:' | head -1 | sed 's/.*: //; s/;.*//'
+```
+
+将得到的 `JSESSIONID=xxx` 传给 `--cookie` 参数。
+
+#### 1.4 单独查询某个 VO/DTO 完整定义（兜底）
+
+如果脚本已经解析过、但 AI 后续发现某个 `definitionsDetail` 之外的 VO 也需要展开，用：
+
+```bash
+python3 .../extract_swagger.py --file /tmp/swagger-raw.json --definition KnowledgeOperLogVO
+```
+
+找不到时会自动给出模糊匹配建议（最多 10 个）。
+
+#### 1.5 输出结构（与服务端 `parse_swagger_json` 一致）
+
+```json
+{
+  "info": { "title": "...", "version": "...", "description": "..." },
+  "basePath": "/svc",
+  "tags": [{ "name": "tag", "description": "..." }],
+  "apis": [
+    {
+      "url": "/tag/pageList",
+      "method": "POST",
+      "tag": "tag",
+      "summary": "标签分页查询",
+      "operationId": "tagPageList",
+      "parameters": [
+        { "name": "body", "in": "body", "required": true,
+          "dtoRef": "TagQueryDTO",
+          "dtoProperties": [ /* 递归展开，required 字段已标注 */ ] }
+      ],
+      "response": { "voName": "ResponseTagPage", "properties": [ /* 递归展开 */ ] }
+    }
+  ],
+  "definitions": [ /* 摘要：所有 VO/DTO 的 name + type + description */ ],
+  "definitionsDetail": [ /* 详情：被 apis 引用的 VO/DTO 及传递闭包，深度5 */ ],
+  "_filter": { "keywords": ["tag"], "total": 50, "matched": 12 }   // 仅 --filter 生效时出现
+}
+```
+
+### 二、服务端兜底路径（脚本不可用时）
 
 **步骤 1：调用服务端 api_tool**
 
@@ -111,41 +229,38 @@ api_tool(action="fetch", url="http://10.2.7.60:30194/ikmp-knowledge/swagger-ui/i
 }
 ```
 
-**步骤 3：AI 通过 run_command 在本地执行 curl**
-
-根据返回数据中的 `authInfo` 和 `swaggerEndpoints`，AI 自行构造 curl 命令并通过 `run_command` 在本地执行：
-
-3a. **鉴权（如 authInfo.hasPassword 为 true）**：
+**步骤 3：本地 curl 写入临时文件（禁止管道截断！）**
 
 ```bash
-curl -s -D - -X GET 'http://10.2.7.60:30194/ikmp-knowledge/swagger-resources/configuration/ui' \
-  -H 'Authorization: Basic <base64(username:password)>' \
-  -H 'Accept: application/json'
-```
+# 鉴权（如需要）
+curl -sS -D - -X GET '<authUrl>' \
+  -H 'Authorization: Basic <base64(user:pass)>' \
+  -o /dev/null | grep -i '^set-cookie:' | head -1 | sed 's/.*: //; s/;.*//'
 
-从输出的 `Set-Cookie:` 行提取 Cookie 值（分号前的部分）。
-
-3b. **获取 API 文档 JSON**：直接使用 `swaggerEndpoints.apiDocsUrl`：
-
-```bash
-curl -s -X GET 'http://10.2.7.60:30194/ikmp-knowledge/v2/api-docs' \
+# 下载 API 文档（务必 -o 写文件，不要 | head / | python）
+curl -sS --connect-timeout 10 --max-time 30 \
   -H 'Accept: application/json' \
-  -H 'Cookie: <步骤3a获取的Cookie>'
+  -H 'Cookie: <步骤上一步的 Cookie>' \
+  -o /tmp/swagger-raw.json \
+  '<apiDocsUrl>'
 ```
 
-如果 authInfo.hasPassword 为 false，省略 Cookie 头。
-
 **步骤 4：调用服务端解析**
 
 ```
-api_tool(action="parse_swagger_json", swaggerJson="<步骤3b获取的JSON字符串>", swaggerSourceUrl="http://10.2.7.60:30194/ikmp-knowledge/swagger-ui/index.html")
+api_tool(
+  action="parse_swagger_json",
+  swaggerJson=<读取 /tmp/swagger-raw.json 的完整内容>,
+  swaggerSourceUrl="http://10.2.7.60:30194/ikmp-knowledge/swagger-ui/index.html",
+  apiFilter=["tag"]   // 可选，强烈推荐：按关键词过滤 + 自动裁剪 definitionsDetail
+)
 ```
 
 **步骤 5：返回解析结果**
 
-将 `parse_swagger_json` 返回的解析结果直接返回给用户，格式与正常 fetch 完全一致。
+将返回结果直接呈现给用户。
 
-### 二、联调测试（action=test）
+### 三、联调测试（action=test）
 
 **步骤 1：调用服务端 api_tool**
 
@@ -196,13 +311,24 @@ curl -s -X POST 'http://10.2.7.60:30194/ikmp-knowledge/api/xxx' \
 
 将 curl 的响应内容返回给用户。如果是 JSON 格式，尽量格式化输出。
 
+## ⚠️ 避坑指南（来自历史反馈）
+
+1. **禁止用 `curl | head/tail/jq/python` 对完整 Swagger JSON 做管道切片** —— curl 管道经常因下游 SIGPIPE 截断，导致 JSON 不闭合 / Python 解析失败 / 临时写花括号平衡脚本，是历史踩坑率最高的反模式。**必须用 `-o /tmp/xxx.json` 写文件**，再用脚本或 `parse_swagger_json` 处理。
+2. **不要在本地手写 Python 切 Swagger** —— `extract_swagger.py` 已经做了和服务端 `parseApiDocs` 完全对齐的递归展开、传递闭包、required 标注、过滤裁剪。本地手写一个 mini 版只会丢字段或踩 `$ref`/`originalRef` 双字段陷阱。
+3. **过滤优先用 `--filter`（脚本）或 `apiFilter`（服务端）** —— 不要先拿全量再让 AI 自己挑接口看，过滤后 `definitionsDetail` 会自动按传递闭包裁剪，输出量减少 70%+。
+4. **单 VO 查询用 `--definition`（脚本）或 `get_definition`（服务端）** —— 不要回头再拉一次全量。
+
 ## 快捷方式：AI 直接识别 10 段地址
 
-如果 AI 能识别出用户请求的 URL 中包含 `10.x.x.x` 主机地址，可以**直接跳过首次 api_tool 调用**，在本地执行 curl，再调用 `parse_swagger_json`，减少一次无用的服务端请求：
+如果 AI 能识别出用户请求的 URL 中包含 `10.x.x.x` 主机地址，可以**直接跳过首次 api_tool 调用**，在本地执行脚本，减少一次无用的服务端请求：
 
-1. 从 Swagger URL 推导鉴权地址、文档地址
-2. 通过 `run_command` 在本地依次 curl
-3. 调用 `api_tool(action="parse_swagger_json")` 解析
+```bash
+python3 ~/.qwen/extensions/szcd-component-helper/skills/local-api-tool/scripts/extract_swagger.py \
+  --url 'http://10.x.x.x/<service>/v2/api-docs' \
+  [--cookie '<JSESSIONID=...>'] \
+  [--filter '<关键词>'] \
+  --out /tmp/parsed.json
+```
 
 ### URL 推导规则
 
@@ -214,33 +340,11 @@ curl -s -X POST 'http://10.2.7.60:30194/ikmp-knowledge/api/xxx' \
 | authUrl | `basePath + /swagger-resources/configuration/ui` | `http://10.2.7.60:30194/ikmp-knowledge/swagger-resources/configuration/ui` |
 | apiDocsUrl | `basePath + /v2/api-docs` | `http://10.2.7.60:30194/ikmp-knowledge/v2/api-docs` |
 
-### curl 执行模板
-
-**鉴权（带密码时）：**
-```bash
-curl -s -D - -X GET '<authUrl>' \
-  -H 'Authorization: Basic <base64(username:password)>' \
-  -H 'Accept: application/json'
-```
-
-**获取文档（带 Cookie 时）：**
-```bash
-curl -s -X GET '<apiDocsUrl>' \
-  -H 'Accept: application/json' \
-  -H 'Cookie: <鉴权获取的Cookie>'
-```
-
-**获取文档（无密码时）：**
-```bash
-curl -s -X GET '<apiDocsUrl>' \
-  -H 'Accept: application/json'
-```
-
 ## 注意事项
 
-1. **Cookie 传递**：鉴权步骤获取的 Cookie 需要在后续步骤中通过 `-H 'Cookie: xxx'` 传递
+1. **Cookie 传递**：鉴权步骤获取的 Cookie 通过 `--cookie` 传给脚本，或通过 `-H 'Cookie: xxx'` 传给 curl
 2. **无密码场景**：如果用户未提供密码，跳过鉴权步骤，直接获取文档
-3. **JSON 格式**：curl 获取的 API 文档必须是有效的 Swagger JSON，否则 `parse_swagger_json` 会报错
-4. **超时处理**：本地 curl 可能因网络原因超时，建议添加 `--connect-timeout 10 --max-time 30` 参数
-5. **错误处理**：如果某步骤 curl 失败，将错误信息返回给用户，不要继续后续步骤
-6. **自动执行**：AI 识别 `reason: "LOCAL_NETWORK_UNREACHABLE"` 后应**自动**通过 `run_command` 执行 curl，无需让用户手动复制粘贴命令
+3. **JSON 格式**：脚本/curl 获取的 API 文档必须是有效的 Swagger JSON，否则 `extract_swagger.py` / `parse_swagger_json` 会报错（脚本会打印预览前 200 字符方便排查）
+4. **超时处理**：脚本和 curl 都已内置 `--connect-timeout 10 --max-time 30`，可通过 `--timeout` 调整
+5. **错误处理**：脚本退出码 1=参数错误 / 2=网络IO / 3=解析；如果某步骤失败，将错误信息返回给用户，不要继续后续步骤
+6. **自动执行**：AI 识别 10.x.x.x 或 `reason: "LOCAL_NETWORK_UNREACHABLE"` 后应**自动**通过 `run_command` 执行脚本，无需让用户手动复制粘贴命令