mcpField
D
docs-check

docs-check

github.com/oliver-kriska测试与质量57145 次安装1 周前更新
代码仓库

关于 docs-check

docs-check 是用于检查 Claude Code 插件的 Skill，可依据当前文档验证 Agent、技能、钩子和配置。它结合缓存文档比对与本地结构检查，并支持按组件限定范围。

主要功能

  1. 01验证 Agent、技能、钩子和配置
  2. 02获取并缓存 Claude Code 文档
  3. 03仅运行结构检查的快速模式
  4. 04按指定组件进行检查
  5. 05报告问题并提供 PR 选项

适用场景

  1. 01检查插件是否受文档变更影响
  2. 02不获取文档，仅运行本地结构检查
  3. 03只审查钩子或配置
  4. 04查找适用于插件组件的新功能

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/oliver-kriska/claude-elixir-phoenix --skill docs-check

安装后在 Claude Code 中输入/docs-check确认已加载。

附带文件references/doc-pages.mdreferences/validation-rules.md

详细介绍

插件文档兼容性检查

根据最新的 Claude Code 文档验证插件 Agent、技能、钩子和配置，以发现破坏性变更和新功能。

用法

/docs-check                    # Full validation (all components)
/docs-check --quick            # Structural checks only (no docs fetch, no tokens)
/docs-check --focus=agents     # Validate only agents
/docs-check --focus=skills     # Validate only skills
/docs-check --focus=hooks      # Validate only hooks
/docs-check --focus=config     # Validate only plugin.json/marketplace.json

架构（OTP 监督模式）

┌─────────────────────────────────────────────────────────────────┐
│  /docs-check (skill entry point)                                │
│   │                                                             │
│   ├─ Step 1: bash scripts/fetch-claude-docs.sh (zero tokens)    │
│   │          Always fetches all 9 doc pages (~420KB)             │
│   │                                                             │
│   └─ Step 2: delegate to orchestrator (reads from cache only)   │
│       │                                                         │
│       │  docs-validation-orchestrator (opus)                    │
│       │                                                         │
│       │  SCAN → READ CACHE → SPAWN WORKERS → COMPRESS → REPORT │
│       │   │         │              │             │          │   │
│       │   ↓         ↓              ↓             ↓          ↓   │
│       │ inventory  pre-fetched  4 parallel    context    report │
│       │ plugin     docs-cache   subagents     supervisor       │
│       │ components              (sonnet)      (haiku)          │
│       └─────────────────────────────────────────────────────────┘
└─────────────────────────────────────────────────────────────────┘

执行

步骤 1：获取文档（自动）

始终首先运行。 将所有文档页面下载到缓存。跳过 24 小时内已缓存的页面。零令牌成本——纯 curl。

# --quick mode: skip this step entirely (structural checks only)
# All other modes: always fetch
bash scripts/fetch-claude-docs.sh
步骤 2：委派给编排器

文档缓存完成后，进行委派。编排器仅读取缓存；如果缓存文件缺失则会崩溃。

Task(subagent_type: "docs-validation-orchestrator")

在提示词中传递用户的标志（--quick、--focus）。

编排器的工作内容

  1. 清点 — 扫描 plugins/elixir-phoenix/ 中的现有组件
  2. 读取缓存文档 — 从 .claude/docs-check/docs-cache/ 读取（绝不获取文档）
  3. 启动工作进程 — 每种组件类型启动一个 sonnet 子 Agent，并行运行
  4. 压缩 — 如果有 3 个或更多工作进程，则使用 context-supervisor（haiku）
  5. 结构检查 — 快速本地检查，始终运行
  6. 报告与处理 — 编写报告；如果发现问题，则提供 PR

铁律

  1. 预先获取所有文档 — 不进行条件式获取，不进行部分下载
  2. 使用 scripts/fetch-claude-docs.sh — 获取文档的唯一真实来源
  3. 在提示词中向工作进程提供文档 — 不进行运行时获取
  4. 工作进程使用 sonnet — 对比任务使用 opus 是浪费
  5. 始终运行结构检查 — 即使获取文档失败也要运行
  6. 破坏性变更属于阻塞项 — 突出显示

参考资料

  • references/validation-rules.md — 各组件的验证检查清单
  • references/doc-pages.md — 组件到 URL 的映射

评论

支持 Markdown