mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
0dbd69f970
* Document setting up additional integrations from Slack Generated-By: mintlify-agent * Remove first-class integrations note Generated-By: mintlify-agent --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
114 lines
6.5 KiB
Plaintext
114 lines
6.5 KiB
Plaintext
---
|
|
title: "Add the agent to Slack"
|
|
description: "Add the Mintlify agent to Slack to ask questions about your docs, create documentation updates from conversations, and capture team knowledge."
|
|
keywords: ["Slack integration", "Slack bot", "team collaboration", "agent integration", "knowledge capture"]
|
|
---
|
|
|
|
<Note>
|
|
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it.
|
|
</Note>
|
|
|
|
## Connect your Slack workspace
|
|
|
|
1. Go to the [Agent](https://dashboard.mintlify.com/products/agent) page in your dashboard.
|
|
2. In the "Agent settings" section, click **Install Slack app**.
|
|
<Frame>
|
|
<img src="/images/agent/install-apps-light.png" alt="The App settings section with the Slack, Linear, and Notion install buttons." className="block dark:hidden" />
|
|
<img src="/images/agent/install-apps-dark.png" alt="The App settings section with the Slack, Linear, and Notion install buttons." className="hidden dark:block" />
|
|
</Frame>
|
|
3. Follow the Slack prompts to install the `mintlify` app in your workspace.
|
|
4. Follow the Slack prompts to link your Mintlify account to your Slack workspace.
|
|
5. Test that the agent is working and responds when you:
|
|
- Send a direct message to the agent.
|
|
- Mention the agent with `@mintlify` in a channel.
|
|
|
|
<Tip>
|
|
If your organization has multiple deployments, the agent asks you to choose which deployment to work with the first time you send a request.
|
|
|
|
Your preferred deployment is personal to your Slack account and does not affect
|
|
other team members. You can switch to a different deployment at any time during a
|
|
conversation by clicking the **Switch deployment** button on the agent's status
|
|
message in the thread. The agent retains your conversation history so you can
|
|
continue where you left off with the new deployment.
|
|
</Tip>
|
|
|
|
## Connect additional integrations from Slack
|
|
|
|
Once your Slack workspace is connected, you can ask the agent in Slack to set up any third-party integration that it should use as context. The agent uses [Composio](https://docs.composio.dev/toolkits) to support a broad catalog of third-party services, including issue trackers, knowledge bases, CRMs, and developer tools.
|
|
|
|
To add a new integration from Slack:
|
|
|
|
1. In a direct message or a thread that mentions `@mintlify`, ask the agent to set up the integration. For example:
|
|
- "Set up the GitHub integration."
|
|
- "Connect Jira so you can read tickets."
|
|
- "Install the HubSpot integration."
|
|
2. The agent replies with an authorization link.
|
|
3. Click the link, sign in to the third-party service, and approve the requested permissions.
|
|
4. Return to Slack. The agent confirms the connection and can immediately use the integration as context for future requests.
|
|
|
|
The connection is scoped to your organization, so you only need to set up each integration once. To remove or reauthorize an integration later, use the **Agent settings** section of the [Agent](https://dashboard.mintlify.com/products/agent) page.
|
|
|
|
For the full list of supported services, see the [Composio toolkits catalog](https://docs.composio.dev/toolkits).
|
|
|
|
## Use the agent in Slack
|
|
|
|
Once connected, you can:
|
|
|
|
- Send direct messages to the agent to use it privately.
|
|
- Mention `@mintlify` in a channel to use it publicly and collaboratively.
|
|
- Attach files and images directly to your messages for the agent to process and include in your docs.
|
|
- Continue conversations in threads to iterate on changes or ask follow-up questions.
|
|
- Share pull request links with the agent to update related documentation.
|
|
|
|
## Ask questions about your docs
|
|
|
|
Ask the agent questions about your product or documentation and receive answers in the thread.
|
|
|
|
- **New question**: Send a direct message to the agent or mention `@mintlify` in a channel with your question.
|
|
- **Existing thread**: Reply in the thread and mention `@mintlify` with a follow-up question.
|
|
|
|
Example questions:
|
|
- "Which pages mention the API rate limit?"
|
|
- "How do I set up authentication?"
|
|
- "How is our navigation structured?"
|
|
|
|
## Update documentation
|
|
|
|
Use the agent to update your documentation with a new request or in an existing thread.
|
|
|
|
- **New request**: Send a direct message to the agent or mention `@mintlify` in a channel with instructions on what to update.
|
|
- **Existing thread**: Reply in the thread and mention `@mintlify` with instructions on what to update.
|
|
- **With attachments**: Upload images, diagrams, code files, or other documents with your message. The agent automatically processes and includes them in your documentation.
|
|
|
|
The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates.
|
|
|
|
## Reference other repositories
|
|
|
|
The agent can read source code from any repository that has the Mintlify GitHub App installed, even if it isn't your documentation repository. This lets the agent build deeper context to guide documentation updates.
|
|
|
|
When you mention another repository in your request, the agent clones it on demand and inspects the relevant files before drafting changes.
|
|
|
|
Example prompts:
|
|
|
|
- "Update the authentication guide based on the changes in `acme/api-server/src/auth.ts`."
|
|
- "Document the new endpoints added in `acme/backend#1234`."
|
|
- "What repositories do you have access to?"
|
|
|
|
Cloned repositories are read-only. The agent uses them for context, but always opens pull requests against your documentation repository.
|
|
|
|
## Track progress in real time
|
|
|
|
When the agent is making changes to your documentation, it provides live feedback in the Slack thread.
|
|
|
|
- **Status updates**: A live-updating message shows what the agent is doing, such as how many files it has searched, read, and edited.
|
|
- **Task progress**: When the agent breaks your request into multiple tasks, it displays a checklist so you can track progress on each one.
|
|
- **Questions**: If the agent needs more information, it presents options for you to select from or reply in the thread with a custom answer.
|
|
- **Interruptions**: If you send a follow-up message while the agent is still working, it stops the current task and starts on the new one.
|
|
- **Completion**: When the agent finishes, it posts a summary with a link to the pull request and a link to open the changes in the web editor.
|
|
|
|
## Best practices
|
|
|
|
- **Be specific**: Tell the agent exactly what you want to know or what you want changed and where.
|
|
- **Add context**: If a thread doesn't contain all the necessary information, include additional details in your message to the agent.
|
|
- **Review carefully**: You should always review pull requests that the agent creates before merging them.
|