核心用法
DocClaw 是一款面向 OpenClaw 生态的专业文档技能,设计目标是在用户询问 how/why 类问题、查询精确配置键值或获取权威文档链接时,提供可追溯、可验证的答案来源。其工作流程分为三级:
1. 实时文档搜索(Primary)
通过 openclaw docs "<query>" 快速检索官方文档库,返回 3-7 条带相关性说明的链接,适用于快速定位主题。
2. 精准模式(Precision Mode)
- 索引刷新:
refresh_docs_index.py更新文档索引 - 精确获取:
fetch_doc_markdown.py按 slug 或标题关键词拉取 Markdown 原文,支持如cli/models、gateway/configuration等精确路径
3. 离线回退(Offline Fallback)
当网络不可用时,自动切换至本地文档根目录,通过 find_local_docs.py 定位并配合 rg(ripgrep)进行本地搜索。
显著优点
- 权威对齐:强制使用
docs.openclaw.ai域名,拒绝第三方来源,确保答案与官方标准一致 - 防幻觉机制:明确禁止"发明"参数、路径或行为,要求关键行为必须通过
openclaw <cmd> --help二次验证 - 纵深防御:1.0.3 版本引入 URL 重验证机制,索引来源的链接须经可信域名校验,防止索引污染攻击
- 跨平台兼容:原生支持 macOS 与 Linux,依赖标准 Python3 环境
潜在缺点与局限性
- 网络依赖:实时搜索与精准获取需 HTTPS 连接,离线模式依赖预置本地文档,更新滞后
- 范围锁定:仅覆盖 OpenClaw 官方文档生态,对第三方插件或社区扩展文档无原生支持
- 验证负担:安全策略要求用户主动运行
--help交叉验证,增加交互步骤 - 单点域名:严格限制
docs.openclaw.ai,若官方迁移域名需技能更新
适合人群
- OpenClaw 运维工程师与 DevOps 从业者
- 需要编写合规配置、避免"幻觉参数"的技术写作者
- 在受限网络环境(如内网部署)中工作的管理员
常规风险
| 风险类别 | 描述 | 缓解措施 |
|---------|------|---------|
| 供应链攻击 | 本地脚本被篡改导致拉取恶意文档 | 1.0.3 版本强制 URL 域名验证,拒绝 off-domain 条目 |
| 索引投毒 | 恶意索引条目指向钓鱼域名 | 重验证机制 + HTTPS 强制 |
| 内容可信 | 拉取文档与运行时行为不一致 | 强制 `--help` 二次验证 |
| 离线数据陈旧 | 本地文档未同步最新变更 | 建议定期执行索引刷新脚本 |
版本与维护
当前版本 1.0.3(2026-02-18),为安全补丁版本,重点强化索引 URL 验证与测试覆盖率。打包时需注意从父目录构建 zip,排除 .DS_Store 与 __pycache__。