Skip to content
Closed
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
20 changes: 16 additions & 4 deletions ai/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
The agent is available on [Pro and Custom plans](https://mintlify.com/pricing?ref=agent) for anyone with access to your dashboard.
</Info>

The agent creates pull requests with proposed changes to your documentation based on your prompts. When you send a request to the agent, it references your documentation, connected repositories, and Slack messages to create content that follows technical writing best practices and adheres to the Mintlify schema. Access the agent directly in your dashboard, in your Slack workspace, or embed it in custom applications with the API.
The agent creates pull requests with proposed changes to your documentation based on your prompts. When you send a request to the agent, it references your documentation, connected repositories, and Slack messages to create content that follows technical writing best practices and adheres to the Mintlify schema. Access the agent through a resizable panel in your dashboard (press ⌘I on Mac or Ctrl+I on Windows/Linux, or click the agent button), in your Slack workspace, or embed it in custom applications with the API.

Check warning on line 11 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L11

Did you really mean 'resizable'?

Use the agent to:

Expand All @@ -17,16 +17,28 @@
- Search and update existing content
- Answer questions about your docs and technical writing topics

## Use the agent in the dashboard

The agent panel provides a dedicated workspace for interacting with the agent directly in your dashboard. Open the panel by pressing ⌘I (Mac) or Ctrl+I (Windows/Linux), or by clicking the agent button in the dashboard header. On mobile devices, the agent opens as a full-screen modal.

The panel includes three views:

- **Chat**: Send prompts to the agent and view responses in real-time. The agent displays its progress as it works, including which files it's reading or editing. When the agent creates or updates files, you'll see buttons to view the pull request or open the changes in the editor.
- **History**: Browse your previous conversations with the agent. Click any conversation to resume it in the Chat view.
- **Settings**: Configure the agent's integrations and repository access. Connect your Slack workspace and manage which repositories the agent can access as context.

The panel is resizable on desktop—drag the left edge to adjust its width. Your preferred width is saved automatically.

Check warning on line 30 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L30

Did you really mean 'resizable'?

Check warning on line 30 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L30

In general, use active voice instead of passive voice ('is saved').

## Add the agent to your Slack workspace

You can also use the agent in Slack to collaborate with your team on documentation updates.

<Note>
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it.

Check warning on line 37 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L37

Use 'administrator' instead of 'admin'.
</Note>

1. Open the agent panel in your dashboard.
2. Click the **Settings** button.
1. Open the agent panel in your dashboard by pressing ⌘I (Mac) or Ctrl+I (Windows/Linux).
2. Click the **Settings** icon (gear icon) in the panel header to open the Settings view.

Check warning on line 41 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L41

Use parentheses judiciously.
<Frame>
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
Expand All @@ -40,13 +52,13 @@

## 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).
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** view (click the gear icon in the panel header) or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).

Check warning on line 55 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L55

Use parentheses judiciously.

## Embed the agent via API

Use the agent endpoints to [create jobs](/api-reference/agent/create-agent-job), [get a specific job](/api-reference/agent/get-agent-job), and [get all jobs](/api-reference/agent/get-all-jobs).

When creating jobs via the API, you can control whether pull requests are created in draft mode using the `asDraft` parameter (defaults to `true`). Set `asDraft: false` to create non-draft pull requests ready for immediate review and merging in automated workflows.

Check warning on line 61 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L61

In general, use active voice instead of passive voice ('are created').

## Write effective prompts

Expand Down