跳转到主要内容
agent 功能适用于 Pro 和 Custom 方案，所有有权访问你控制台的成员都可以使用。
agent 会根据你的提示为文档创建包含建议修改的拉取请求（PR）。当你向 agent 发送请求时，它会利用你的文档、已连接的代码仓库以及 Slack 消息，生成符合技术写作最佳实践并遵循 Mintlify schema 的内容。你可以在控制台中直接使用 agent，在 Slack 工作区中调用它，或者通过 API 将其嵌入自定义应用中。 你可以使用 agent 来：
  • 根据你的提示、拉取请求链接或 Slack 线程撰写新内容
  • 修改过时的代码示例和 API 参考
  • 查找并更新现有内容
  • 回答关于你的文档和技术写作相关主题的问题

​
在控制台中使用智能助手

在控制台中，你可以通过键盘快捷键 ⌘+I（Mac）或 Ctrl+I（Windows/Linux），或者点击 Ask agent 按钮，直接打开助手面板。 助手面板包括：
  • Chat：发送提示词并接收包含文档修改建议的回复。
  • History：查看并继续之前的对话。
  • Settings：配置 GitHub 应用权限和 Slack 集成。
浅色模式下的助手面板。
当助手进行更改时，你可以直接在对话中查看拉取请求（PR；亦称“合并请求”/Merge Request），或者在 Web 编辑器中打开这些更改。

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

你也可以在 Slack 中使用 agent，与团队协作完成文档更新。
如果你的 Slack 工作区所有者要求安装应用需管理员批准，请先让他们批准 Mintlify 应用，再进行连接。
  1. 在控制台中打开 agent 面板。
  2. 点击 Settings 按钮。
    浅色模式下的设置按钮。
  3. 在 Slack 集成部分选择 Connect 按钮。
  4. 按照 Slack 的提示将 mintlify 应用添加到你的工作区。
  5. 按照 Slack 的提示将你的 Mintlify 账号关联到你的 Slack 工作区。
  6. 测试 agent 是否正常工作，并在以下情况下是否有响应：
    • 向它发送一条直接消息。
    • 在频道中通过 @mintlify 提及它。

​
将代码仓库连接为 context

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

​
通过 API 嵌入 Agent

使用 Agent 端点来创建任务、获取指定任务以及获取全部任务。 通过 API 创建任务时，你可以使用 asDraft 参数（默认为 true）来控制是否以草稿模式创建拉取请求（PR；亦称“合并请求”/Merge Request）。将 asDraft 设置为 false 可创建非草稿的拉取请求，以便在自动化工作流中立即进行审核和合并。

​
编写高效的提示词

将代理视为需要你指引来完成任务的 AI 助手。请提供清晰的指令和上下文。任务越聚焦越容易完成，因此把复杂项目拆解为更小的步骤。 让你的提示词具体且以结果为导向。像 @mintlify Improve the onboarding page 这样的泛化提示会应用通用最佳实践，但可能无法按照你设想的方式针对性地改进内容。 围绕你希望用户达成的结果或他们遇到的问题来设计提示词。例如：
  • @mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI
  • @mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key
对于修正错别字、更新重定向或在整个文档中重命名功能等常规内容维护，可以使用更宽泛的提示词。例如：
  • @mintlify Find and fix all typos in the docs
  • @mintlify change all unordered lists to use * instead of -

​
指定域名

如果你拥有多个文档站点，请在消息中包含 subdomain 参数，用于指定助手应处理哪一个文档集。 要找到你的域名，请查看你想更新的文档集的 dashboard URL。域名是组织名称后面的最后一段。例如，如果你的 dashboard URL 是 https://dashboard.mintlify.com/org-name/domain-name，那么你的域名就是 domain-name。 使用 @mintlify subdomain=<your-domain-name> <your-prompt> 这种格式，引导助手在特定文档集上执行操作。 示例：
  • @mintlify subdomain=public-docs Add a new section to the quickstart about inviting collaborators based on this PR：提示助手仅更新 public-docs 站点上的 quickstart 章节。
  • @mintlify subdomain=customer-docs Update the auth docs for the new authentication method：提示助手仅更新 customer-docs 站点上的认证文档。

​
Agent 工作流

该 Agent 可协助处理多种文档任务。以下工作流展示了将 Agent 集成到文档流程中的一些方式。选择与团队当前工作方式相匹配的方法，并根据你的具体需求进行调整。

​
在 Slack 线程中迭代优化提示词

先向代理发送提示词，然后在同一线程中继续使用 @mintlify 提及它，以完善并迭代其创建的拉取请求（PR）。 例如：@mintlify 我们的快速入门页面需要新增一个“邀请协作者”的章节。然后：@mintlify 新章节应命名为 "Inviting collaborators"。之后可继续进行其他迭代。

​
从代理开始，手动收尾

让代理启动一个项目，然后检出它创建的 branch，并在本地环境或网页版编辑器中完成任务。代理可帮助你起步，随后你可以接手收尾。 例如：@mintlify Update the quickstart page to include information about inviting collaborators，接着检出该 branch，按你偏好的方式进行后续修改。

​
合并功能改动时更新文档

当你合并功能拉取请求（PR）后，将该 PR 链接分享给代理，以便更新相关文档。 例如：@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link]。

​
从拉取请求生成发布说明

向代理提供特定的拉取请求，根据提交历史生成发布说明或更新日志。 例如：@mintlify 为此 PR 生成发布说明：[PR link]。

​
生成代码示例

让智能助手在你的文档各处或特定页面为功能生成代码示例。 例如：@mintlify 生成一个代码示例，帮助更容易理解认证方法。

​
审查现有内容

让代理审查现有内容的技术准确性、风格、语法等方面的问题。 例如：@mintlify Review the API rate limiting section. We changed limits last month

​
响应用户反馈

将用户的反馈提交给助手，以便对你的文档进行有针对性的更新。 例如：@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?.

​
使用 API 实现自动化

将 Agent 集成到你现有的自动化工具中，在代码变更时自动更新文档、触发文档审查，或在多个代码仓库之间同步文档更新。 请参阅教程：当代码合并时自动更新文档 了解如何操作。