Agent-Ready 是一个面向 AI 智能体的代码库准备技能,旨在通过生成文档和结构工件,让代码库更容易被智能体理解和操作。它是 codebase-readiness 的修复配套工具,不负责评分,只负责构建。
用途:
- 搭建 AGENTS.md、ARCHITECTURE.md、docs/ 目录等文档结构。
- 安装回归感知的质量门禁,防止智能体引入新的复杂度或死代码。
- 根据项目检测推荐并安装相关技能。
主要模式:
- scaffold:完整文档设置,创建 docs/ 结构、ARCHITECTURE.md、docs/DOMAIN.md、AGENTS.md,并安装文档检查和质量门禁。
- architecture:根据代码库分析生成 ARCHITECTURE.md,包含概览、代码地图、不变量、边界、横切关注点等。
- agents-md:创建或重构 AGENTS.md,采用渐进式披露原则,保持简洁(约120行以内),包含构建/测试/检查命令、会话启动仪式、完成定义等。
- quality-gates:安装回归感知的质量门禁,阻止新增复杂度,建立技术债务基线。
- migrate:升级已有的 agent-ready 脚手架。
- audit:检查现有文档工件是否最新,评估智能体准备情况。
使用方式: 该技能通常作为智能体技能调用。启动时会检查项目根目录是否存在 AGENT_READY_ASSESSMENT.md,若存在则根据薄弱维度推荐模式;否则根据用户意图选择模式。在选择模式后,会读取推荐技能列表,检测仓库中的框架信号,并提示用户安装匹配的技能(需用户确认)。各模式通过执行一系列 shell 命令进行侦察、生成和安装文件。
适用场景:
- 希望让 AI 编码智能体更高效地理解和修改代码库的团队。
- 需要规范化文档结构(AGENTS.md、ARCHITECTURE.md、docs/)的项目。
- 需要建立质量门禁以防止技术债务增加的项目。
限制:
- 该技能不进行评分,仅构建工件。
- 需要用户确认后才能安装推荐技能。
- 质量门禁基线需用户审查批准后才创建。
- 文档内容需团队确认,尤其是领域术语和架构决策。
- 具体支持的语言和框架未在资料中明确列出,但通过文件检测支持多种常见技术栈。