Skip to content

update

用途

重新验证配置、清除缓存并重新下载所有规范文件。这是工作区的完全刷新 — 它确保所有缓存的规范是最新的,并且索引被重建。

何时使用

  • 远程规范文件已更改,你想要最新版本
  • 在编辑 swag2mcp.yaml 以添加或更改规范位置后
  • 排查过时或损坏的缓存时
  • 在运行 mcp 之前确保一切是最新的

语法

bash
swag2mcp update [path]

参数

参数位置必需描述
path1工作区目录。如果省略,通过路径解析规则解析。

标志

无。

工作原理

update 命令运行一系列操作:

  1. 加载配置 — 从工作区读取 swag2mcp.yaml
  2. 验证 — 运行与 validate 相同的检查(YAML 语法、结构、规范文件可达性、格式、认证、HTTP 客户端)
  3. 清理 — 删除 cache/responses/ 的所有内容
  4. 重新缓存 — 下载所有远程规范文件并将本地规范文件复制到缓存
  5. 重新索引 — 为所有端点重建全文搜索索引
  6. 认证脚本 — 为使用 ScriptAuth 的 spec 创建存根认证脚本
  7. 孤立清理 — 删除不再存在的 spec 的认证脚本
bash
swag2mcp update
swag2mcp update ./my-workspace

禁用的 collection 会发生什么

带有 disable: true 的 collection 被完全跳过 — 它们不会被缓存或索引。

命令后验证

bash
swag2mcp ls [path]
# 所有 spec 应仍然列出且可达

细节

  • 无自动初始化: 如果配置文件不存在,update 返回错误:"configuration not found at <path>"。先运行 init
  • 网络依赖: 所有远程规范 URL 必须可达。如果任何下载失败,整个更新失败并显示清晰的错误消息。
  • 认证脚本创建: 如果 spec 使用 ScriptAuth 且存根脚本不存在,update 会创建它。如果创建失败,更新失败。
  • update vs clean clean 只删除缓存。update 删除缓存重新下载所有内容。当你只想释放空间时使用 clean;当你想刷新时使用 update