浏览 AI使用教程

AGENTS.md 怎么写:记录构建命令、规范、禁区和完成标准

AGENTS.md 应该保存每次任务都必须知道的项目事实:构建命令、文件来源、禁止动作和完成标准。写成可执行规则,Agent 才不用反复猜。

需要哪一项,就直接查到哪一段

把表格、命令、清单或规则作为工作中的查询工具,不要求从头顺序阅读。

这张表什么时候有用

每次都要重新提醒的项目规则,应该写进哪里

Agent 每次进入仓库都重新猜构建命令,有时运行全量格式化,有时修改生成文件。口头提醒不会随新任务稳定传递。

  • 真实命令
  • 规则与动作分别验证
  • 不把规则等同沙箱
字段参考

可执行项目规则文件要写清哪些字段

要记录的内容怎么填写检查点
适用范围说明规则覆盖目录、子目录覆盖方式和多文件优先级。Agent 知道当前文件受哪组规则约束
项目入口列依赖、启动、构建、测试、格式化和生成命令及工作目录。命令已在当前仓库实测
编辑边界指出权威内容源、生成物、禁止目录、用户改动处理和允许的重构范围。不会误改产物或覆盖他人工作
风险与权限部署、删除、迁移、密钥、网络和生产操作的确认要求。不可逆动作有明确停止点
完成标准要求 diff、测试、截图、日志、回滚和未验证项。完成可被另一人复核

完整根目录与局部规则

AGENTS.md

仓库根目录

# 项目规则
- 先读README.md与git status --short,保留已有修改。
- content/是源;public/由scripts/build.mjs生成,不手改。
- 从根目录运行node scripts/build.mjs与node --test,记录实际输出。
- 只改任务相关源;不顺改依赖、URL、路由或footer。
- 未授权部署、删除或外部写入先报告影响与所需动作。
- 完成列修改、命令、结果和未测项;失败保留错误。
content/AGENTS.md

局部补充

# 内容约定
- 简体中文;标题由正文支持。
- 教学预期与实际记录分开。
- 易变事实附官方来源和核验日期。
- 临时任务不追加到长期规则。

新会话先只读规则并列适用文件、命令与禁区,再用小任务查diff。复述正确不代表实际遵守;阻止访问需真实权限。

作用域另查产品专页

本页给仓库协作模板;加载顺序见 [Codex项目规则](../../../codex-guides/codex-agents-project-rules.html)。反向测试只让它解释为何不应手改public/,不以真实删除测试边界。

本例材料

这份可执行项目规则文件服务哪项任务

需要确认本例内容
现有材料教学仓库content/为源、public/为产物,Node构建与内置测试。写进真实规则前必须核对脚本。
不能越过的边界AGENTS.md 记录可执行规则和作用域,不粘贴长篇背景;秘密和个人路径不进入文件;与当前仓库实际一致。
要交付的结果可执行项目规则文件
最终输出

完成后的可执行项目规则文件

预期工具复述边界且实际遵守;AGENTS.md是任务指令,不是强制权限屏障。客户端与系统权限独立配置。

常见失败

为什么“规则文件很完整,Agent 仍然违反”还不能交付

规则文件很完整,Agent 仍然违反

原因
规则太长、冲突或作用域位置错误
怎么改
精简为可执行条目,检查嵌套规则优先级并用一个真实任务测试
验收方式

可执行项目规则文件通过哪些检查才算完成

依据与范围

本页实际使用的资料