跳转到主要内容
agent 需要 Pro 或 Enterprise 方案。
agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议更改的拉取请求 (PR；亦称“合并请求”/Merge Request) 。当你发送请求时，agent 会：
  • 调研：搜索并阅读你现有的文档、所有已连接的代码仓库、相关上下文以及网络内容。
  • 规划：为复杂的文档工作创建结构化任务清单。
  • 撰写：生成或更新内容，遵循写作规范和最佳实践。
  • 验证：运行 Mintlify 命令行界面 (CLI) 检查，确保文档可以正确构建。
  • 创建 PR：打开一个包含建议更改的拉取请求 (PR；亦称“合并请求”/Merge Request) ，供你审核。
所有更改都会通过拉取请求完成。agent 永远不会直接向你的主 branch 进行提交。

​
开始使用

  1. 在控制台中打开 Agent 页面。
  2. 在你希望 agent 处理的仓库上安装 Mintlify GitHub App。
  3. 通过 agent 面板、Slack，或在已连接的仓库中打开一个 pull request，发送你的第一个请求。
  4. 审核 agent 打开的 pull request，并在准备就绪时合并它。

​
agent 如何保持安全

  • 仅打开 pull request。agent 永远不会直接向你的部署 branch 进行 commit。
  • 只访问你通过 Mintlify GitHub App 连接的仓库。
  • 将非文档仓库视为只读，仅用于获取上下文，绝不向其写入。
  • 在任何更改进入你的正式站点之前，都需要人工审核并合并。

​
你可以用智能助手做什么

使用智能助手可以：
  • 根据你的提示词、拉取请求 (PR；亦称“合并请求”/Merge Request) 、Slack 线程或文件附件撰写新内容。
  • 根据新功能或 API 变更更新现有文档。
  • 处理并插入来自 Slack 附件的图片、图表和其他文件。
  • 在你的文档中搜索并修改代码示例和 API 参考。
  • 引用任何已安装 Mintlify GitHub 应用的仓库中的源代码。
  • 通过自动化处理文档维护工作。
  • 回答与你的文档和技术写作相关的问题。
  • 处理代码审查反馈并维护文档质量。
  • 在知识从 Slack 对话和拉取请求中流失之前，将其记录下来。
  • 高效地在多个文件和目录之间导航并协调更改。

​
连接你的 GitHub 账户

默认情况下，代理会以 Mintlify 机器人身份创建拉取请求 (PR；亦称“合并请求”/Merge Request) 。若要将拉取请求归属到你的账号，请在控制台的 My profile 页面连接你的 GitHub 账户。

​
将仓库连接为上下文

Agent 只能访问你通过 Mintlify GitHub 应用连接的仓库。你可以在 agent 面板的 Settings 中，或在 GitHub 应用设置 中配置 agent 可访问的仓库。

​
与 agent 配合使用 AI 工具

agent 通过拉取请求异步工作，但你也可以在本地使用 Cursor 或 Claude Code 等 AI 编码工具进行快速、迭代式编辑。安装 Mintlify skill 并连接 MCP 服务器，让你的编辑器拥有与 agent 相同的上下文。 要让外部代理通过 MCP 工具调用直接编辑你的内容，请将其连接到 Mintlify MCP 服务器。

为 AI 编码工具安装 Mintlify skill 和 MCP 服务器。

在 Cursor 中打开

​
后续步骤

连接 Slack

将 agent 添加到你的 Slack 工作区。

自定义行为

使用 AGENTS.md 文件配置 agent。

编写高效的提示词

使用更聚焦的提示词以获得更好的效果。

使用自动化实现自动化

使用自动化处理重复性任务和文档维护。