将 agent 添加到 Slack

在 Slack 中使用 agent 可更新内容、提出问题并沉淀团队知识。在频道中 @ 该 agent 即可协作使用，或通过私信单独使用。在 Slack 中与 agent 的对话是免费的，不计入组织的积分余额。

1. 在控制台中进入 Agent 页面。
2. 在 “Agent settings” 部分，点击 Install Slack app。
3. 按照 Slack 的提示将 mintlify 应用安装到你的工作区。
4. 按照 Slack 的提示将你的 Mintlify 账户关联到你的 Slack 工作区。
5. 测试 agent 是否正常工作，并在你执行以下操作时是否会响应：
   • 向 agent 发送一条私信。
   • 在频道中使用 @mintlify 提及 agent。

要从你的 Slack 工作区中移除 agent：

1. 在你的 dashboard 中打开自动化页面。
2. 单击 Disconnect Slack 以撤销 Mintlify 与你的工作区之间的连接。
3. 在 Slack 中，打开 Settings & administration > Manage apps，找到 mintlify 应用并单击 Remove。

断开连接后，agent 将停止响应提及和直接消息，向 Slack 发布消息的自动化也将停止发送通知。你可以随时按照连接你的 Slack 工作区中的步骤重新连接。 如果你需要重新授权 agent —— 例如，在 Slack 范围更新后授予新的权限，或在 token 被撤销后进行恢复 —— 请从你的 Mintlify dashboard 重新安装该应用。 当你将 agent 重新安装到已经连接到你组织的工作区时，Mintlify 会原地刷新已存储的 bot token。你现有的频道和线程都会保持不变。 连接完成后，你可以：

• 向智能体发送私信，在私密环境中使用它来更新文档。
• 在频道中提及 @mintlify，在公开场景中与团队协作使用它。
• 在消息中直接附加文件和图片，让智能体处理并将其纳入文档。
• 在线程中继续对话，对修改内容持续迭代或提出后续问题。智能体会将该线程中先前共享的文件和图片作为后续请求的上下文重复使用，因此你无需再次上传。
• 将拉取请求（PR；亦称”合并请求”/Merge Request）链接分享给智能体，以更新相关文档。

向智能体询问关于你的产品或文档的问题，并在线程中收到回答。

• 新问题：直接给智能体发送私信，或在频道中通过 @mintlify 提及智能体并附上你的问题。
• 已有线程：在线程中回复并使用 @mintlify 提出后续问题。

示例问题：

• “哪些页面提到了 API 速率限制？”
• “如何设置身份验证？”
• “我们的导航是如何组织的？“

Slack agent 在回答问题或更新文档时，可以将已连接的第三方应用作为只读工具使用。

• 共享集成可供整个组织使用。
• 个人集成使用正在与 agent 对话的团队成员所连接的账户。

你不需要为每次 Slack 对话选择集成。只需在请求中自然提及应用，例如：“将这个 Linear issue 与我 Google Drive 中的发布计划进行比较。” 如果应用尚未连接，请让 agent 连接它。完成 agent 返回的授权链接，然后在同一线程中再次发送消息，让 agent 确认并使用该连接。 有关支持的应用、连接范围和权限，请参见集成。 使用智能体在新请求或现有线程中更新你的文档。

• 新请求：向智能体发送直接消息，或在频道中提及 @mintlify，并说明需要更新的内容。
• 现有线程：在该线程中回复并提及 @mintlify，并说明需要更新的内容。
• 包含附件：在消息中上传图片、图表、PDF、SVG、代码文件或其他文档。智能体会自动处理这些附件，并将其内容纳入你的文档中。在线程中，智能体可以访问较早消息中共享的图片和文件，因此你可以在后续请求中引用它们，无需再次上传。

智能体会读取请求或线程的上下文，并更新你已连接的存储库。根据你的审核流程设置，智能体会打开拉取请求（PR；亦称”合并请求”/Merge Request）或直接向你的部署 branch 提交。 如果你想让更改落到部署 branch 以外的位置，请让智能体针对具体的 branch。例如”针对 staging branch 打开 PR”或”将这些 commits 推送到 docs-refresh”。智能体会针对你指定的 branch 创建拉取请求，或者当该 branch 已存在时，直接向该 branch 推送 commits。 当自动化针对其打开的 pull request 发布 Slack 通知时，可以在该线程中回复并提及 @mintlify 以继续该工作。Agent 会获取该运行的完整上下文，checkout 同一 branch，并将你请求的更改作为后续 commits 推送到同一 pull request，而不是新开一个。 你也可以直接与 agent 分享任意 Mintlify pull request 的链接，从新的线程中继续处理该 PR。 当 code change 自动化打开一份文档 pull request 时，它会在触发它的代码 pull request 上发表评论，链接到它创建的文档 pull request，并按顺序尝试代码 pull request 的作者和 committers，直到有人接受，将其指派为审阅者。 Slack agent 和自动化都使用 Mintlify agent。请求 agent 创建、配置、运行或排查任意自动化。它可以执行你在控制台 Automations 页面上的所有操作。 示例提示词：

• “创建一个自动化，每次合并到 main 时都起草一条 changelog 条目。”
• “设置一个自动化，每当 Jira issue 关闭时就更新文档。”
• “关闭每周的 changelog 自动化。”
• “对 PR #123 运行 code change 自动化。”
• “回顾上个月的合并并更新 changelog。”

你也可以询问智能体关于自动化的活动情况，例如近期的运行、失败情况或积分使用。

• “如何让我的自动化更节省积分？”
• “code change 自动化上一次运行为什么失败？“

​

从 Slack 消息触发自动化

你可以配置自定义自动化，让它在有人在选定的 Slack 频道中发布顶级消息时运行。Agent 会读取每条消息，判断是否需要更新文档，并在需要时打开 pull request。在 Automations 页面创建或编辑自动化时进行此设置。 mintlify 应用必须是所选频道的成员。在保存自动化前，使用 /invite @mintlify 邀请它加入。 智能体可以读取任何已安装 Mintlify GitHub 应用的仓库中的源代码，即使该仓库不是你的文档仓库。这让智能体能够构建更深入的上下文，以指导文档更新。 当你在请求中提到其他仓库时，智能体会按需克隆该仓库，并在起草更改之前检查相关文件。 示例提示词：

• “根据 acme/api-server/src/auth.ts 中的更改，更新身份验证指南。”
• “为 acme/backend#1234 中新增的端点编写文档。”
• “你可以访问哪些仓库？”

克隆的仓库为只读。智能体将它们用作上下文，但只会将更改写入你的文档仓库。 当智能体处理你的请求时，它会在 Slack 线程中提供实时反馈。

• 状态更新：一条实时更新的消息会显示智能体正在执行的操作，例如已搜索、读取和编辑了多少文件。
• 任务进度：当智能体将你的请求拆分为多个任务时，它会显示一个清单，以便你跟踪每个任务的进度。
• 提问：如果智能体需要更多信息，它会列出选项供你选择，或者你可以在线程中回复自定义答案。
• 中断：如果你在智能体仍在工作时发送后续消息，它会停止当前任务并开始处理新任务。
• 完成：当智能体完成后，它会发布一份摘要，其中包含指向拉取请求（PR）或提交的链接和在 Web 编辑器中打开更改的链接。

智能体在 Slack 中的能力与已关联的 Mintlify 账号的角色保持一致：

• 管理员和编辑者：可以提问并对文档进行修改。智能体可以使用文件编辑和拉取请求工具。
• 查看者：仅能提问。无论请求是什么，智能体针对 Mintlify 工具始终以只读模式运行。

如需更改同事的权限，请在控制台的 Members 页面更新其角色。

​

在 Slack 侧边面板中使用 agent

在 Slack 侧边面板中与 @mintlify 聊天，可无需在频道中发布消息即可提问或请求更新文档。侧边面板中的 agent 与 Slack agent 行为一致：相同的权限、相同的工具，以及对其所做更改的相同审阅流程。

• 具体说明：清楚地告诉 agent 你希望文档记录哪些内容，以及它应该放在哪里。
• 添加上下文信息：如果一个对话中不包含所有必要信息，请在发给 agent 的消息中补充更多细节。
• 仔细审查：在合并之前，你应始终审查 agent 创建的拉取请求（PR；亦称”合并请求”/Merge Request）。