用途:分析项目的编码约定,并在项目根目录生成一份简洁的 AGENTS.md,供 AI 代理遵循项目特定规范。
主要能力与做法:
- 先检查项目根目录是否已有 AGENTS.md;若已存在则停止并告知用户,不覆盖。
- 探索代码库,阅读有代表性的源码文件(非配置文件),识别命名方式、状态管理、错误处理、测试约定、自定义抽象或包装、偏离语言/框架默认的写法、目录约定等模式。
- 写出 AGENTS.md,规则为:最多 20 条指令;每条占一行,不用多行项目符号;只写本项目独有且不明显的内容;不列目录结构;不写语言或框架的标准做法;不写合格开发者可自行推断的内容。重点放在项目特定模式、偏离默认的命名约定、必须使用的自定义抽象、本代码库特有的坑。
输出格式:
Project Coding Conventions
- <单行指令>
- <单行指令>
限制与提醒:不要为凑满 20 条而填充,少量精准指令优于大量泛泛而谈;避免重复语言/框架已强制的内容;若找不到足够独特约定,即使不足 5 行也应如实说明并写下已发现的约定。
适用场景:需要在项目中为新加入的 AI 代理建立上下文约定时使用。 收费、价格、支持平台与具体安装方式暂未提供。