AGENTS.md是Codex项目代理配置的唯一入口,必须置于根目录且全小写命名;含Agents、Capabilities、Constraints、Policies四强制区块,顺序不可变;缺失或格式错误将导致agent init失败且排查困难。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

为Codex项目编写AGENTS.md文件,是定义AI代理行为边界的必要操作,直接决定后续所有自动化任务的执行逻辑和安全水位。
明确AGENTS.md的核心作用
这个文件不是可选文档,而是Codex运行时加载代理配置的【唯一入口】。缺失或格式错误会导致agent init失败,且错误提示不指向具体行,排查耗时翻倍。
它必须放在项目根目录,名称全小写、带扩展名,大小写错一个字母(比如Agents.md)就会被忽略。
基础结构:四段式强制区块
每份AGENTS.md必须严格包含以下四个一级区块,顺序不可调换,缺一不可:
① ## Agents —— 代理身份注册区,列出所有可用agent名称及基础描述;
② ## Capabilities —— 每个agent能调用哪些工具/函数,用YAML列表声明;
③ ## Constraints —— 硬性限制项,如最大token数、禁止访问域名、输出长度上限;
④ ## Policies —— 行为策略,含敏感词拦截规则、重试逻辑、fallback响应模板。
区块之间空一行,区块标题必须用两个#,不能用三个#或加粗替代。
Agents区块写法:名称+角色+启用开关
每个agent占三行,按此顺序:
- 第一行:### agent_name(仅字母数字下划线,首字符必须为字母);
- 第二行:Role: 描述该agent在系统中的职能,不超过15字,例如“负责代码审查”;
- 第三行:Enabled: true/false —— false时整个agent被跳过,但语法仍需校验通过。
通过本地 Codex 或 OpenClaw OAuth 凭证直接调用 ChatGPT/Codex Responses 的 image_generation 工具来生成或编辑光栅图像,然后保存
注意:agent_name不能与Python内置模块名冲突(如json、sys、time),否则运行时报ImportError而非配置错误。
Capabilities区块:工具绑定必须带版本号
方法一:单agent绑定
在对应agent名称下方缩进2空格,写- tool_name@v1.2.0(版本号必须精确到patch级);
方法二:全局共享能力
用shared:开头另起一段,后面跟YAML列表,每个工具行末加# required表示启动时强制校验存在。
没写版本号的工具引用会被静默忽略,不报错也不加载——这是最常被忽略的隐形故障点。
Constraints区块:三项必填,少一项就启动失败
必须包含:max_tokens、allowed_hosts、output_length_limit三个键。
allowed_hosts值必须是数组格式,即使只允许一个域名也要写成["api.example.com"],写成字符串"api.example.com"会导致解析中断。
max_tokens设为0表示不限制,但生产环境严禁这样做——会触发LLM无终止生成,吃光GPU显存。
Policies区块:敏感词规则写法
敏感词匹配区分大小写,规则行格式为:deny: "信用卡号|CVV|身份证号";
正则表达式禁止使用(?i)等修饰符,全部用小写书写并靠大小写控制匹配粒度;
fallback响应模板中可用{{query}}变量插入原始输入,但不可嵌套{{ }},否则渲染时报KeyError。

















