文档

项目指南(AGENTS.md)

项目指南(AGENTS.md)

AGENTS.md 是一个纯 Markdown 文件,承载项目级指令:结构、约定与工作流。Memo 会自动读取它,确保在该仓库中工作的 Agent 遵循同一套规则。

AGENTS.md 存放位置#

AGENTS.md 可以存在于仓库中的任何位置:

  • 项目根目录(例如 <project-root>/AGENTS.md
  • 任意子目录——每个 AGENTS.md 的作用范围是包含它的整个目录树

Memo 启动时自动检测并加载 AGENTS.md:

  • 对于你接触的每个文件,Memo 都会遵守作用范围内所有 AGENTS.md 中的指令。
  • 嵌套更深的 AGENTS.md 在冲突时优先。
  • 仓库根目录的 AGENTS.md 已包含在提示中——无需重新读取。

应该放什么内容#

AGENTS.md 适合记录:

  • 项目结构:目录组织、重要文件位置
  • 技术栈:主要框架、库、工具版本
  • 开发工作流:构建、测试、部署命令
  • 代码约定:命名规范、文件组织、风格指南
  • 安全注意:敏感文件、环境变量处理
  • 已知问题:常见陷阱及解决方案

保持简洁,只记录项目独有信息——避免重复 package.json 或 README 中已有的内容。

自动生成#

在会话中使用 /init 斜杠命令,或运行 CLI 命令:

memo init

Memo 会分析当前项目并生成一份包含技术栈、命令和约定的 AGENTS.md

memo initgit init 一样是幂等的:

  • 如果 AGENTS.md 已存在,绝不改动——Memo 会提示并跳过
  • 如需重新生成,先删除该文件

维护责任#

重要:如果你修改了 AGENTS.md 中提到的任何内容,请同步更新:

  • 添加/删除重要目录
  • 更改构建/测试命令
  • 更新技术栈
  • 修改代码约定

上下文加载顺序#

Memo 按以下顺序构建系统提示:

  1. 基础系统提示
  2. AGENTS.md(项目指南层)
  3. Skills(如果有)

这意味着:

  • AGENTS.md 的指令适用于其作用范围内的所有工作
  • 当前回合中用户的明确指令拥有最高优先级
  • AGENTS.md 和 skills 都不能覆盖安全规则与工具策略

持久化偏好#

跨项目持久化的用户级偏好,请参阅 记忆系统get_memory 读取 ~/.memo/Agents.md)。

相关#