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
41 changes: 30 additions & 11 deletions ai/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,36 +17,55 @@
- Search and update existing content
- Answer questions about your docs and technical writing topics

## Access the agent in your dashboard

The agent is available as a resizable panel in your dashboard. Open it by:

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'?

- Pressing **Cmd+I** (Mac) or **Ctrl+I** (Windows/Linux)
- Clicking the agent icon in the dashboard header

The agent panel includes three views:

- **Chat**: Send prompts and view responses with pull request links
- **History**: Access previous conversations and continue where you left off
- **Settings**: Configure Slack integration and connected repositories

<Note>
Screenshots showing the agent panel interface will be updated in a future release.

Check warning on line 34 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L34

Avoid using 'will'.

Check warning on line 34 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L34

In general, use active voice instead of passive voice ('be updated').
</Note>

## 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.
<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:
1. Open the agent panel in your dashboard by pressing **Cmd+I** (Mac) or **Ctrl+I** (Windows/Linux).
2. Click the **Settings** icon (gear icon) in the panel header.

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.
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:

1. Open the agent panel by pressing **Cmd+I** (Mac) or **Ctrl+I** (Windows/Linux).
2. Click the **Settings** icon (gear icon) in the panel header.

Check warning on line 59 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L59

Use parentheses judiciously.
3. Configure repository access in the **Set up external sources** section.

You can also manage repository access in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L68

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

## Write effective prompts

Expand Down