Harness 双文档一致性审查
读取 Harness 能力变更、源码与两份文档,核对行为、示例和链接,输出按严重程度排序的修复清单。
功能与用途
用于 Pydantic AI Harness 能力变更合并前的文档验收。提供变更说明或当前分支,即可对照能力源码、包内 README 与文档站页面,检查参数、默认值、安装选项、安全限制和稳定性说明是否一致,并验证示例代码及链接规范。结果按阻断、警告和细节问题列出文件与修复建议,不直接修改文件。需要在对应仓库中使用;运行示例检查还需具备项目测试环境,涉及外部服务的示例需有模拟测试支持。
适用场景
- 新增能力的文档验收:检查新能力是否同时提供 README 与文档站页面,并核对源码链接及公开接口说明。
- 参数变更后的同步检查:对照源码核查两份文档中的构造参数、默认值和安装选项,找出遗漏或过时描述。
- 文档示例可运行性验证:运行示例检查与确定性代码片段,检查导入、能力接线以及外部服务示例的模拟测试。
- 安全限制与稳定性审阅:核对 Shell、CodeMode、FileSystem 的限制说明,以及能力稳定性提示是否在两份文档中一致。
适用人群
- Pydantic AI Harness 维护者
- Harness 能力贡献者
- 开发者文档审阅者
使用步骤
- 提供能力名称与变更说明,或指定当前分支。
- 读取源码、README、文档站页面及写作约定。
- 核对行为说明、示例、安全限制与链接。
- 运行示例检查,验证变更片段。
- 查看按严重程度排序的文件问题与修复建议。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-11-03
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Use as the final documentation gate before a `pydantic-ai-harness` capability PR merges. Verifies that a user-facing change keeps the capability README under `src/pydantic_ai_harness/pydantic_ai_harness/` and its `docs/harness/` page in sync with each other and with the code, that every snippet is runnable, and that links follow repo convention. Reports gaps; does not edit. Skip it for changes that touch no harness capability or its docs.
使用前准备
- 可访问 pydantic/pydantic-ai 仓库中的能力源码、README 和 docs/harness/ 页面。
- 提供能力变更说明,或保留可供识别变更范围的当前分支差异。
- 运行示例检查需可使用 uv 和项目测试环境;外部服务示例需提供模拟测试。