讲师中心 微信公众号
AI工具推荐 视频效率加速

Codex AGENTS.md怎么写?项目长期守则配置详解【技巧】

云明吖_7196

云明吖_7196

发布时间:2026-06-14 23:04:07

|

1232人浏览过

|

来源于php中文网

原创

AGENTS.md是Codex项目代理配置的唯一入口,必须置于根目录且全小写命名;含Agents、Capabilities、Constraints、Policies四强制区块,顺序不可变;缺失或格式错误将导致agent init失败且排查困难。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

codex agents.md怎么写?项目长期守则配置详解【技巧】

为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 Imagen
Codex Imagen

通过本地 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。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
WorkBuddy核心功能与实操模式
WorkBuddy核心功能与实操模式

深入探索WorkBuddy的强大功能。本专题包含智能问答、文档处理、会议纪要生成、日程管理、任务协作等核心模块的操作指南与最佳实践。通过图文并茂的教程,助您快速上手,最大化发挥WorkBuddy的办公效能。

622

2026.04.09

Codex AI 编程代理与智能开发工作流
Codex AI 编程代理与智能开发工作流

Codex 是一款超越传统代码生成的 AI 编程代理,致力于构建全生命周期的智能开发工作流。通过持久线程保留上下文,支持多智能体并行协作与后台自动化运维。借助沙箱权限控制、Plan/Steer 任务管理机制,Codex 既能自主拆解并执行复杂工程任务,又能让开发者牢牢掌控项目进程。从需求分析、编码测试到代码审查与部署,Codex 将 AI 深度融入研发全链路,极大提升了软件工程的交付效率与质量标准。

574

2026.05.26

Codex API集成与AI编程生态开发
Codex API集成与AI编程生态开发

Codex API 集成是构建下一代 AI 编程生态的核心基石,能通过 API 将强大的代码生成与推理能力无缝接入 VS Code、JetBrains 等主流 IDE 插件,还能将其深度嵌入 CI/CD 流水线,实现自动化的代码审查、单元测试生成与 Bug 修复。结合 Amazon Bedrock 等云平台的托管服务,企业可以灵活打造符合内部安全规范的专属 AI 编程助手。

244

2026.05.26

Codex 模型原理与AI软件工程进阶
Codex 模型原理与AI软件工程进阶

Codex 是基于通用大模型底座,通过海量代码语料与真实 Pull Request 进行专项微调的代码专用模型,能深度理解代码语法树与跨文件依赖,实现从自然语言到高质量工程代码的精准转化。在 AI 软件工程进阶中,Codex 推动了从提示词工程向“驾驭工程(Harness Engineering)”的范式跃迁。

177

2026.05.26

Codex AI编程工具新手指南
Codex AI编程工具新手指南

全面解析Codex AI编程工具的核心原理、功能特点与实际用途,提供适合新手的Codex入门教程、环境配置方法、代码生成演示与常见问题解答,帮助开发者快速掌握AI自动写代码能力,提升编程学习与开发效率。

410

2026.05.27

Codex Agent编程与自主开发能力调优专题
Codex Agent编程与自主开发能力调优专题

PHP中文网为您提供Codex Agent编程与自主开发能力调优专题。针对AI Agent全权委托开发模式,我们为您系统梳理了Harness Engineering(驾驭工程)核心理念,以及涵盖AGENTS.md规范编写、Skills技能配置、Worktree沙盒隔离与多Agent协作架构的实战指南。

228

2026.06.10

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

Playwright 页面操作指南
Playwright 页面操作指南

Playwright页面操作专题汇集元素定位、点击与输入、等待响应、多页面切换、Iframe、事件监听及文件处理的已审核文章,便于按操作场景查阅示例与常见问题。

0

2026.10.21

Playwright 入门教程
Playwright 入门教程

Playwright入门专题汇集测试框架安装、VS Code配置、录制脚本、编写首个用例、运行调试及查看报告的已审核文章,帮助初学者搭建端到端测试流程。

0

2026.10.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Codex 应用程序简介
Codex 应用程序简介

共0课时 | 167人学习

Codex官方文档
Codex官方文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn