Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@
To add the app to a workspace, open your organization's app management page (a URL like `https://app.slack.com/manage/<your-org-id>/integrations/installed`). Find the `mintlify` app and install it to your workspace.
</Warning>

<Note>
The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) deployments.

If your Git provider is behind an IP allowlist, allow the Mintlify egress IP `54.242.90.151` so the agent can clone your repository. Contact support to opt in.
</Note>

### Disconnect the agent

To remove the agent from your Slack workspace:
Expand All @@ -62,6 +68,8 @@
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.

You can also share a link to a pull request in any connected deployment. The agent switches to that deployment automatically and continues the PR.
</Tip>

## Use the agent in Slack
Expand Down Expand Up @@ -123,26 +131,35 @@

## Continue an automation run

When an [automation](/automations) posts a [Slack notification](/automations/manage#slack-notifications) about a pull request it opened, reply in that thread and mention `@mintlify` to continue the work. The agent checks out the automation's branch and pushes your requested changes as follow-up commits to the same pull request, rather than opening a new one.
When an [automation](/automations) posts a [Slack notification](/automations/manage#slack-notifications) 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.

You can also share a link to an automation's 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 linking to the docs pull request it created, and assigns a reviewer by trying the code pull request's author and committers in order until one accepts.

## Manage automations

Ask the agent to create, configure, or run [automations](/automations). The agent can perform the same actions as you on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard.
The Slack agent and [Automations](/automations) both use the Mintlify agent. Ask the agent to create, configure, run, or troubleshoot any automation. It can perform every action available to you on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard.

Example prompts:

- "Create an automation that drafts a changelog entry every time we merge to main."
- "Set up an automation that updates the docs whenever a Jira issue closes."
- "Turn off the weekly changelog automation."
- "Run the automation that reviews assistant conversations right now."
- "Run the code change automation on PR #123."
- "Review the last month of merges and update the changelog."

You can also ask the agent about automation activity, such as recent runs, failures, or credit use.

- "How can I make my automations more credit efficient?"

Check warning on line 154 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L154

Avoid first-person pronouns such as ' I '.

Check warning on line 154 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L154

Avoid first-person pronouns such as 'my'.
- "Why did the last run of the code change automation fail?"

### 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 on the [Automations](https://app.mintlify.com/products/automations) page.

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](/deploy/github) or [GitLab integration](/deploy/gitlab), even if it isn't your documentation repository. This lets the agent build deeper context to guide documentation updates.
Expand Down Expand Up @@ -172,10 +189,14 @@
The agent's capabilities in Slack match users' [roles](/dashboard/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 runs in read-only mode for Mintlify 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](https://app.mintlify.com/settings/organization/members) page of your dashboard.

## Use the agent in the Slack sidepanel

Check warning on line 196 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L196

Did you really mean 'sidepanel'?

Chat with `@mintlify` in the Slack side panel to ask questions or request documentation updates without posting in a channel. The sidepanel agent behaves like the Slack agent: same permissions, same tools, and the same review process for any changes it makes.

Check warning on line 198 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L198

Did you really mean 'sidepanel'?

## Best practices

- **Be specific**: Tell the agent exactly what you want to know or what you want changed and where.
Expand Down
Loading