AGENTS.md的最佳实践

张开发
2026/4/14 4:58:20 15 分钟阅读

分享文章

AGENTS.md的最佳实践
如果把 AI 编程助手比作一台超跑,那么AGENTS.md就是它的方向盘和导航仪。它是位于项目根目录的特定配置文件(目前已被 Cursor、Windsurf、Claude Code 等主流 AI 编辑器广泛支持),本质上相当于给 AI 注入的“系统级提示词”。为了让 AI 从“听话的执行者”进阶为“懂你的神队友”,以下是AGENTS.md的四大维度最佳实践:一、 精准定位:划定 AI 的“能力圈”与“禁区”AI 不知道项目的背景,所以第一步是要帮它建立“世界观”。明确技术栈:直接告诉 AI 项目用了什么框架、语言和核心库(例如:React 18 + TypeScript + Tailwind CSS + Node.js)。这能避免 AI 推荐过时的 API 或错误的语法。划定业务边界:一句话概括项目是做什么的。比如:“这是一个面向 B 端电商的供应链管理系统,主要处理订单履约。”设立安全护栏(Do's Don'ts):明确告诉 AI 什么绝对不能做。例如:“禁止将硬编码的密钥提交到代码库”、“禁止修改/dist目录下的文件”。二、 规范工作流:让 AI 掌握你的“肌肉记忆”优秀的搭档不需要你每次都交代细节,他们知道你的习惯。统一步骤:规定 AI 在执行任务前必须先做什么、后做什么。例如:“在编写新功能前,必须先检查相关的已有组件避免重复造轮子;写完代码后必须运行 lint 检查。”命名与架构约定

更多文章