用途:create-agents-md 是一项创建 AGENTS.md 文件的指南,用于编写项目特有的内联规则并提交到仓库中。
主要能力与结构:AGENTS.md 是无元数据的简单 Markdown 文件,可用于项目根目录或子目录。根目录 AGENTS.md 承载整个项目的主要指令与引用,涵盖命令、技术栈、测试、代码风格、架构和安全边界;子目录 AGENTS.md 用于文件夹或包级别的规则,适用于单体仓库中的特定包、服务或测试目录。智能体通常会结合最近一层 AGENTS.md 与父级文件中的指令。
使用方式:在项目根目录创建 AGENTS.md,写清代码风格、架构等约定;仅在本地行为与根级明显不同时才添加嵌套 AGENTS.md。保持文件小而聚焦,优先使用简短具体的引用而非长篇描述,可链接项目文档、规范与运行手册,指向示例文件或目录,并列出最重要命令的完整 CLI 调用;随项目演进更新内容。
不适用场景:跨项目复用的知识应使用 skills;大型文档应使用带 references 的 skills;复杂工作流应使用带 scripts 的 skills。
限制:资料未提供具体的安装命令、平台或收费信息;更详细的最佳实践见 references/best-practices.md。