mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
367a4a633b
* Document Slack agent access for viewer-role users Generated-By: mintlify-agent * 💅 --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
131 lines
7.7 KiB
Plaintext
131 lines
7.7 KiB
Plaintext
---
|
||
title: "将 agent 添加到 Slack"
|
||
description: "将 Mintlify agent 添加到 Slack，从对话中创建文档更新、沉淀团队知识并保持文档同步。"
|
||
keywords: ["Slack 集成", "Slack 机器人", "团队协作", "agent 集成", "知识沉淀"]
|
||
---
|
||
|
||
<Note>
|
||
如果你的 Slack 工作区所有者要求安装应用需先经管理员批准，请先请他们批准 Mintlify 应用，然后再进行连接。
|
||
</Note>
|
||
|
||
<div id="connect-your-slack-workspace">
|
||
## 连接你的 Slack 工作区
|
||
</div>
|
||
|
||
1. 在控制台中进入 [Agent](https://dashboard.mintlify.com/products/agent) 页面。
|
||
2. 在 "Agent settings" 部分，点击 **Install Slack app**。
|
||
<Frame>
|
||
<img src="/images/agent/install-apps-light.png" alt="应用设置区域，包含 Slack 和 Notion 安装按钮。" className="block dark:hidden" />
|
||
<img src="/images/agent/install-apps-dark.png" alt="应用设置区域，包含 Slack 和 Notion 安装按钮。" className="hidden dark:block" />
|
||
</Frame>
|
||
3. 按照 Slack 的提示将 `mintlify` 应用安装到你的工作区。
|
||
4. 按照 Slack 的提示将你的 Mintlify 账户关联到你的 Slack 工作区。
|
||
5. 测试 agent 是否正常工作，并在你执行以下操作时是否会响应：
|
||
- 向 agent 发送一条私信。
|
||
- 在频道中使用 `@mintlify` 提及 agent。
|
||
|
||
<Tip>
|
||
如果你的组织有多个部署，agent 会在你首次发送请求时要求你选择要使用的部署。
|
||
|
||
你的首选部署仅与你的 Slack 账户关联，不会影响其他团队成员。你可以在对话过程中随时切换到其他部署，只需点击线程中 agent 状态消息上的
|
||
**Switch deployment** 按钮。Agent 会保留你的对话历史记录，以便你在新部署上从之前中断的地方继续。
|
||
</Tip>
|
||
|
||
<div id="connect-additional-integrations-from-slack">
|
||
## 从 Slack 连接其他集成
|
||
</div>
|
||
|
||
连接好你的 Slack 工作区后，你可以在 Slack 中让 agent 设置它应当用作上下文的任意第三方集成。Agent 使用 [Composio](https://docs.composio.dev/toolkits) 来支持广泛的第三方服务，包括问题跟踪器、知识库、CRM 和开发者工具。
|
||
|
||
<Note>
|
||
GitHub 和 GitLab 不通过 Composio 配置。仓库访问由从控制台安装的 [Mintlify GitHub App](/zh/deploy/github) 或 [GitLab 集成](/zh/deploy/gitlab)管理。安装后，agent 可以读取该应用有权访问的任何仓库的源代码。
|
||
</Note>
|
||
|
||
要从 Slack 添加新的集成：
|
||
|
||
1. 在私信中，或在提及 `@mintlify` 的线程中，让 agent 设置该集成。例如：
|
||
- "连接 Jira，以便你可以读取工单。"
|
||
- "安装 HubSpot 集成。"
|
||
- "设置 Linear 集成。"
|
||
2. Agent 会回复一个授权链接。
|
||
3. 点击该链接，登录第三方服务，并批准所请求的权限。
|
||
4. 返回 Slack。Agent 会确认连接成功，并立即可以将该集成用作后续请求的上下文。
|
||
|
||
你从 Slack 连接的集成的作用域为你个人的 Slack 用户，每位团队成员都需要设置各自的连接，agent 会使用发送消息者的连接。如果某位 Slack 用户没有连接某项服务，agent 会回退到从控制台中 [Agent](https://dashboard.mintlify.com/products/agent) 页面安装的组织级集成。
|
||
|
||
如需移除或重新授权某个组织级集成，请使用 [Agent](https://dashboard.mintlify.com/products/agent) 页面的 **Agent settings** 部分。
|
||
|
||
有关支持的服务的完整列表，请参阅 [Composio toolkits 目录](https://docs.composio.dev/toolkits)。
|
||
|
||
<div id="use-the-agent-in-slack">
|
||
## 在 Slack 中使用智能体
|
||
</div>
|
||
|
||
连接完成后，你可以：
|
||
|
||
- 向智能体发送私信，在私密环境中使用它来更新文档。
|
||
- 在频道中提及 `@mintlify`，在公开场景中与团队协作使用它。
|
||
- 在消息中直接附加文件和图片，让智能体处理并将其纳入文档。
|
||
- 在线程中继续对话，对修改内容持续迭代。
|
||
- 将拉取请求（PR；亦称"合并请求"/Merge Request）链接分享给智能体，以更新相关文档。
|
||
|
||
<div id="update-documentation">
|
||
## 更新文档
|
||
</div>
|
||
|
||
使用智能体在新请求或现有线程中更新你的文档。
|
||
|
||
- **新请求**：向智能体发送直接消息，或在频道中提及 `@mintlify`，并说明需要更新的内容。
|
||
- **现有线程**：在该线程中回复并提及 `@mintlify`，并说明需要更新的内容。
|
||
- **包含附件**：在消息中上传图片、图表、代码文件或其他文档。智能体会自动处理这些附件，并将其内容纳入你的文档中。
|
||
|
||
智能体会读取请求或线程的上下文，并在你已连接的存储库中创建一个包含这些更新的拉取请求（PR；亦称"合并请求"/Merge Request）。
|
||
|
||
<div id="reference-other-repositories">
|
||
## 引用其他仓库
|
||
</div>
|
||
|
||
智能体可以读取任何已安装 Mintlify GitHub 应用的仓库中的源代码，即使该仓库不是你的文档仓库。这让智能体能够构建更深入的上下文，以指导文档更新。
|
||
|
||
当你在请求中提到其他仓库时，智能体会按需克隆该仓库，并在起草更改之前检查相关文件。
|
||
|
||
示例提示词：
|
||
|
||
- "根据 `acme/api-server/src/auth.ts` 中的更改，更新身份验证指南。"
|
||
- "为 `acme/backend#1234` 中新增的端点编写文档。"
|
||
- "你可以访问哪些仓库？"
|
||
|
||
克隆的仓库为只读。智能体将它们用作上下文，但始终会针对你的文档仓库提交拉取请求（PR；亦称"合并请求"/Merge Request）。
|
||
|
||
<div id="track-progress-in-real-time">
|
||
## 实时跟踪进度
|
||
</div>
|
||
|
||
当智能体处理你的请求时，它会在 Slack 线程中提供实时反馈。
|
||
|
||
- **状态更新**：一条实时更新的消息会显示智能体正在执行的操作，例如已搜索、读取和编辑了多少文件。
|
||
- **任务进度**：当智能体将你的请求拆分为多个任务时，它会显示一个清单，以便你跟踪每个任务的进度。
|
||
- **提问**：如果智能体需要更多信息，它会列出选项供你选择，或者你可以在线程中回复自定义答案。
|
||
- **权限请求**：在智能体执行需要写入数据的第三方操作之前（例如发送邮件或创建工单），它会请求你批准或拒绝该操作。审批卡片以临时消息的形式发送，仅对你（即发起请求的人）可见，因此不会打扰线程中的其他参与者。点击 **Approve** 让智能体继续执行，或点击 **Deny** 取消该操作。
|
||
- **中断**：如果你在智能体仍在工作时发送后续消息，它会停止当前任务并开始处理新任务。
|
||
- **完成**：当智能体完成后，它会发布一份摘要，其中包含指向拉取请求（PR）的链接和在 Web 编辑器中打开更改的链接。
|
||
|
||
<div id="roles-and-permissions">
|
||
## 角色与权限
|
||
</div>
|
||
|
||
智能体在 Slack 中的能力与已关联的 Mintlify 账号的[角色](/zh/dashboard/roles)保持一致：
|
||
|
||
- **管理员和编辑者**：可以提问并对文档进行修改。智能体可以使用文件编辑和拉取请求工具。
|
||
- **查看者**：仅能提问。智能体以只读模式运行，无法使用文件编辑、提交和拉取请求工具。第三方集成会被过滤为只读操作。如果查看者请求智能体进行修改，智能体会说明该限制，并建议联系编辑者或管理员同事。
|
||
|
||
如需更改同事的权限，请在控制台的 [成员](https://dashboard.mintlify.com/settings/organization/members) 页面更新其角色。
|
||
|
||
<div id="best-practices">
|
||
## 最佳实践
|
||
</div>
|
||
|
||
- **具体说明**：清楚地告诉 agent 你希望文档记录哪些内容，以及它应该放在哪里。
|
||
- **添加上下文信息**：如果一个对话中不包含所有必要信息，请在发给 agent 的消息中补充更多细节。
|
||
- **仔细审查**：在合并之前，你应始终审查 agent 创建的拉取请求（PR；亦称"合并请求"/Merge Request）。
|