跳转到主要内容
在你的文档项目根目录下创建一个 .mintlify/AGENTS.md 文件,用来自定义 Agent 的行为(Agents.md 也是可接受的文件名)。
将你的 AGENTS.md 文件放在 .mintlify/ 目录内,而不是放在项目根目录下。如果你将文件存放在项目根目录下,你的自定义指令将通过 /agents.md 路径公开访问。.mintlify/ 目录不会被公开提供服务,因此当你的 AGENTS.md 文件位于该目录中时,它不会被公开访问。如果你必须将 AGENTS.md 文件存放在项目根目录或其他目录中,请将其添加到你的 .mintignore 文件中,以将其从文档站点中排除。
添加你希望 Agent 遵循的任何指令。Agent 会将这些指令追加到它的 system prompt(系统提示词)中,因此这些指令会应用于所有任务,无论你是在控制台中、在 Slack 上,还是通过 API 使用 Agent。

在 AGENTS.md 中应包含的内容

可以考虑添加以下说明:
  • 风格偏好:与你的文档相关的文风、语气、格式和术语。
  • 代码规范:在示例中使用的编程语言、框架和编码约定。
  • 内容要求:针对不同类型页面应包含哪些部分或信息。
  • 项目背景:与你的产品、架构或用户群体相关的具体细节,用于制定文档相关决策。

AGENTS.md 文件示例

.mintlify/AGENTS.md