> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/mintlify/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# What is the agent?

> Automate documentation updates with the agent. Create updates from Slack messages, PRs, or API calls.

<Info>
  The agent is available on [Enterprise plans](https://mintlify.com/pricing?ref=agent) for anyone with access to your dashboard.
</Info>

The agent is an AI tool that creates pull requests with proposed changes to your documentation based on your prompts. When you send a request, the agent:

* **Researches**: Reads your existing documentation, any connected repositories, and relevant context.
* **Plans**: Creates a structured task list for complex documentation work.
* **Writes**: Generates or updates content following writing standards and best practices.
* **Validates**: Runs Mintlify CLI checks to ensure documentation builds correctly.
* **Creates a PR**: Opens a pull request with proposed changes for review.

All changes go through pull requests. The agent never commits directly to your main branch.

## What you can do with the agent

Use the agent to:

* Write new content based on your prompts, pull requests, Slack threads, or file attachments.
* Update existing documentation for new features or API changes.
* Process and include images, diagrams, and other files from Slack attachments.
* Search and revise code examples and API references across your docs.
* Automate documentation maintenance with workflows.
* Answer questions about your docs and technical writing topics.
* Address code review feedback to maintain documentation quality.
* Capture knowledge from Slack conversations and pull requests before it gets lost.
* Navigate and coordinate changes across multiple files and directories efficiently.

## Where you can use the agent

<CardGroup cols={3}>
  <Card title="Dashboard" icon="browser">
    From any page in your dashboard, use the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) to open the agent panel. Or click **Ask agent** on the [Overview](https://dashboard.mintlify.com/) page.
  </Card>

  <Card title="Slack" icon="slack">
    Add the agent to your Slack workspace and mention `@mintlify` in any channel. You can attach files and images directly to your messages for the agent to process.
  </Card>

  <Card title="API" icon="code">
    Embed the agent in custom applications using the [agent endpoints](/api/agent/create-agent-job).
  </Card>
</CardGroup>

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify-docs/images/agent/dashboard-light.png" alt="The agent panel open in the dashboard." className="block dark:hidden" />

  <img src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify-docs/images/agent/dashboard-dark.png" alt="The agent panel open in the dashboard." className="hidden dark:block" />
</Frame>

## Connect your GitHub account

By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://dashboard.mintlify.com/settings/account) page of the dashboard.

## Connect repositories as context

The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).

## Next steps

<CardGroup cols={2}>
  <Card title="Connect Slack" icon="slack" href="/agent/slack">
    Add the agent to your Slack workspace.
  </Card>

  <Card title="Customize behavior" icon="wrench" href="/agent/customize">
    Configure the agent with an `AGENTS.md` file.
  </Card>

  <Card title="Write effective prompts" icon="pen" href="/agent/effective-prompts">
    Get better results with focused prompts.
  </Card>

  <Card title="Automate with workflows" icon="refresh-cw" href="/agent/workflows">
    Automate recurring tasks and documentation maintenance with workflows.
  </Card>
</CardGroup>