Skip to content
Draft
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
26 changes: 13 additions & 13 deletions ai/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,51 +19,51 @@

## Use the agent in the dashboard

Access the agent panel directly from your dashboard using the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux), or by clicking the **Ask agent** button.
Access the agent in a resizable panel directly from your dashboard using the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux), or by clicking the agent button in the top navigation.

Check warning on line 22 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L22

Did you really mean 'resizable'?

The agent panel includes:
The agent panel includes three views:

- **Chat**: Send prompts and receive responses with proposed documentation changes.
- **History**: View and continue previous conversations.
- **Settings**: Configure GitHub App permissions and Slack integration.
- **Chat**: Send prompts and receive responses with proposed documentation changes. The agent streams responses in real-time and displays tool invocations as it works.
- **History**: View and continue previous conversations. Select any past session to resume where you left off.
- **Settings**: Configure GitHub App permissions for external repositories and manage your Slack integration.

<Frame>
<img src="/images/agent/dashboard-light.png" alt="The agent panel in light mode." className="block dark:hidden" style={{ maxHeight: '500px' }} />
<img src="/images/agent/dashboard-dark.png" alt="The agent panel in dark mode." className="hidden dark:block" style={{ maxHeight: '500px' }} />
</Frame>

When the agent makes changes, you can view the pull request directly from the chat or open the changes in the web editor.
When the agent makes changes, you can view the pull request directly from the chat or open the changes in the web editor. On mobile devices, the agent opens in a full-screen modal for an optimized experience.

## 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 42 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L42

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 using <kbd>⌘</kbd>+<kbd>I</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux).
2. Click the **Settings** icon (gear icon) in the panel header to switch to the Settings view.

Check warning on line 46 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L46

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" />
</Frame>
2. Select the **Connect** button in the Slack integration section.
3. Follow the Slack prompts to add the `mintlify` app to 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:
3. Select the **Connect** button in the Slack integration section.
4. Follow the Slack prompts to add the `mintlify` app to your workspace.
5. Follow the Slack prompts to link your Mintlify account to your Slack workspace.
6. Test that the agent is working and responds when you:
- Send a direct message to it.
- Mention it with `@mintlify` in a channel.

## 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 60 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L60

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 66 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L66

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

## Write effective prompts

Expand Down