Agent

Agent 可帮助你编写和维护文档

Agent 在 Pro 和 Custom 方案 中可用，任何拥有你控制台访问权限的成员都可以使用。

Agent 会根据你的提示为文档提出修改并创建拉取请求（PR）。当你向 Agent 发送请求时，它会参考你的文档、已连接的代码仓库以及 Slack 消息，生成符合技术写作最佳实践并遵循 Mintlify 架构的内容。你可以在 Slack 工作区中使用 Agent，或通过 API 将其嵌入自定义应用。

使用 Agent 可以：

• 基于你的提示、拉取请求链接或 Slack 线程撰写新内容
• 更新过时的代码示例和 API 参考
• 搜索并更新现有内容
• 回答关于你的文档与技术写作主题的问题

开始使用前，将 Agent 添加到你的 Slack 工作区，并在频道中使用 @mintlify 提及它。

​

将代理添加到你的 Slack 工作区

如果你的 Slack 工作区所有者要求安装应用需管理员批准，请在连接之前请他们先批准 Mintlify 应用。

1. 前往控制台中的 agent 页面。
2. 选择 Connect 按钮。
3. 按照 Slack 的提示将 mintlify 应用添加到你的工作区。
4. 按照 Slack 的提示将你的 Mintlify 账户与 Slack 工作区关联。
5. 测试代理是否正常工作并在以下情况下响应：
   • 向其发送一条私信。
   • 在频道中使用 @mintlify 提及它。

​

将仓库连接为 context

代理只能访问你通过 Mintlify GitHub 应用连接的仓库。你可以在 GitHub 应用设置 中修改代理可访问的仓库。

​

通过 API 嵌入 Agent

使用 Agent 端点来创建任务、获取指定任务以及获取全部任务。

​

编写高效的提示词

将代理视为需要你指引来完成任务的 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 参数，以指定代理应处理的子域。

使用 @mintlify subdomain=<your-subdomain> <your-prompt> 的格式来指示代理处理特定子域。

示例：

• @mintlify subdomain=public-docs Add a new section to the quickstart about inviting collaborators based on this PR：指示代理仅在 public-docs 子域的 quickstart 中新增一节，内容为基于此 PR 的协作者邀请。
• @mintlify subdomain=customer-docs Update the auth docs for the new authentication method：指示代理仅在 customer-docs 子域更新认证（auth）文档以适配新的认证方法。

​

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 实现自动化

将代理集成到你现有的自动化工具中，在代码变更时自动更新文档、触发内容审查，或在多个代码库之间同步文档更新。

了解详情请参阅教程代码合并后自动更新文档。