Add the agent to Slack

Use the agent in Slack to update your content, ask questions, and capture team knowledge. Mention @mintlify in a channel to use it collaboratively, or message it in its Chat tab to use it privately. In a channel, the agent replies in a thread. The Slack agent runs on Autopilot. When Autopilot posts in a Slack thread, mention @mintlify in that thread to continue the same conversation with it. You can also ask the agent about Autopilot’s work or tell it to change what Autopilot works on, the same as in a chat with Autopilot.

​

Connect your Slack workspace

1. Open your Automations settings.
2. Click Connect Slack.
3. Follow the Slack prompts to install the mintlify app in your workspace and grant the requested permissions.
4. Confirm the connection in your Mintlify dashboard to your Slack workspace.
5. Test that the agent is working and responds when you:
   • Send it a message in its Chat tab.
   • Mention the agent with @mintlify in a channel.

​

Disconnect the agent

To remove the agent from your Slack workspace:

1. Open your Automations settings.
2. Click Configure Slack.
3. Click Disconnect to revoke the connection between Mintlify and your workspace.
4. In Slack, navigate to Manage apps.
5. Click Remove on the Mintlify app.

When you disconnect the Slack app, the agent stops responding to mentions and direct messages, and automations that post to Slack stop delivering notifications.

​

Reconnect or reinstall the agent

To reauthorize the agent, reinstall the app from your Mintlify dashboard. Reauthorize when you need to grant new permissions after a Slack scope update or when you need to recover from a revoked token. When you reinstall the agent into a workspace that is already connected to your organization, Mintlify refreshes the stored bot token in place. Your existing channels and threads remain intact.

​

Use the agent in Slack

Once connected, you can:

• Mention @mintlify in a channel to use it publicly and collaboratively.
• Message the agent in its Chat tab to use it privately.
• Attach files and images directly to your messages for the agent to process and include in your docs.
• Continue conversations to iterate on changes or ask follow-up questions. In a channel thread, mention @mintlify again and the agent picks up where it left off. It reads messages your teammates posted in the thread since its last reply as context. In the Chat tab, reply in the same chat.
• 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: Mention @mintlify in a channel with your question, or start a new chat in the agent’s Chat tab.
• Existing thread: Reply in the thread and mention @mintlify with a follow-up question. In the Chat tab, reply in the same chat.

Example questions:

• “Which pages mention the API rate limit?”
• “How do I set up authentication?”
• “How is our navigation structured?”

​

Use connected integrations

The Slack agent can use connected third-party apps as read-only tools while answering questions or updating your documentation.

• Shared integrations are available to everyone in your organization.
• Personal integrations use the account connected by the teammate who is chatting with the agent. For example, a Google Drive search uses that teammate’s Drive connection.

You do not have to select integrations for each Slack conversation. Ask the agent to use a connected app naturally in your request, such as:

• “Compare this Linear issue with the launch plan in the connected Google Drive.”
• “Update the migration guide based on the latest Jira issue.”
• “What does our Notion launch brief say about availability?”

Prompt the agent to connect any integrations you want to use. Complete the authorization link it returns, then send another message in the same thread so the agent can confirm the connection. See Integrations for supported apps, connection scopes, and permissions.

​

Update documentation

Use the agent to update your documentation with a new request or in an existing thread.

• New request: Mention @mintlify in a channel with instructions on what to update, or start a new chat in the agent’s Chat tab.
• Existing thread: Reply in the thread and mention @mintlify with instructions on what to update. In the Chat tab, reply in the same chat.
• With attachments: Upload up to five images, PDFs, code files, or other text documents with your message to the agent. The agent automatically processes and includes them in your documentation.

The agent reads the context of the request or thread and updates your connected repository. Depending on your review process setting, the agent either opens a pull request or commits directly to your deployment branch. Ask the agent to target a specific branch if you want changes to land somewhere other than your deploy branch. For example, “open the PR against the staging branch” or “push these commits to docs-refresh.” The agent creates the pull request against the branch you name, or pushes commits directly to it when the branch already exists.

​

Continue an automation run

When an automation posts a Slack notification about a pull request it opened, reply in that thread and mention @mintlify to continue the work. The agent picks up the full run context, checks out the same branch, and pushes your requested changes as follow-up commits to the same pull request, rather than opening a new one. You can also share a link to any Mintlify pull request directly with the agent to continue it from a new thread. When a code change automation opens a documentation pull request, it posts a comment on the triggering code pull request that links to the docs pull request. It then assigns a reviewer by trying the code pull request’s author and committers in order until one accepts.

​

Trigger automations from Slack messages

You can configure a custom automation to run when someone posts a top-level message in a chosen Slack channel. The agent reads each message, decides whether it warrants a documentation update, and opens a pull request when it does. Set this up when you create or edit the automation in your Automations settings. The mintlify app must be a member of the channel you choose. Invite it with /invite @mintlify before saving the automation.

​

Reference other repositories

The agent can read source code from any repository connected through the GitHub App, GitLab integration, or Azure Repos integration, 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?”

The agent treats cloned repositories as read-only. It uses them for context, but only writes changes to your documentation repository.

​

Track progress in real time

When the agent is working on your request, it provides feedback in the Slack thread.

• Progress: A progress indicator shows in the thread while the agent works. The agent removes it when it posts its reply.
• Questions: If your request is ambiguous, the agent asks a short question. Answer in the same thread or chat, mentioning @mintlify if you are in a channel.
• New messages: If you message the agent in the same thread or chat while it is still working, it acknowledges your message and folds it into the current task.
• Busy: If you mention the agent in a thread while it is busy with work from another thread, it posts a message saying so. It starts on your request when that work finishes.
• Completion: When the agent finishes, it posts its reply in the thread with links to the pages, pull requests, or live docs it changed.
• Errors: If something goes wrong, the agent stops and says so in the thread. Message it again to retry.

​

Roles and permissions

The agent’s capabilities in Slack match users’ roles.

• Admins and editors: Can ask questions and make documentation changes. The agent has access to file editing and pull request tools.
• Viewers: Can ask questions only. The agent always runs in read-only mode for Mintlify tools, regardless of the request.

To change a teammate’s permissions, update their role on the Members page of your dashboard.

​

Use the agent in the Slack side panel

Open the agent’s Chat tab, which Slack also shows in the side panel, to ask questions or request documentation updates without posting in a channel. The agent has the same permissions, tools, and review process as it does in channels.

• Press New chat to start a new conversation.
• Reply in a chat to continue that conversation.
• You do not need to mention @mintlify. The agent reads everything you post in the chat.

​

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: Always review pull requests that the agent creates before merging them.