mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
aae35106db
* docs: document agent publishing options * docs: translate agent publishing options to es, fr, zh * docs: align review process wording with dashboard labels * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Aadit Shah <aadit2805@gmail.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
79 lines
4.6 KiB
Plaintext
79 lines
4.6 KiB
Plaintext
---
|
|
title: "What is the agent?"
|
|
description: "Learn how the Mintlify agent researches, plans, and writes documentation, then opens pull requests with proposed changes for your team to review."
|
|
keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"]
|
|
---
|
|
|
|
import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";
|
|
|
|
<Info>
|
|
The agent requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=agent).
|
|
</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**: Searches and reads your existing documentation, any connected repositories, relevant context, and the web.
|
|
- **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.
|
|
- **Publishes changes**: Opens a pull request with proposed changes for review, or commits directly to your deployment branch, depending on your [review process setting](#choose-how-the-agent-publishes-changes).
|
|
|
|
## 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.
|
|
- Reference source code from any repository that has the Mintlify GitHub App installed.
|
|
- Automate documentation maintenance with automations.
|
|
- 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.
|
|
|
|
## 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://app.mintlify.com/settings/account) page of the dashboard.
|
|
|
|
## Choose how the agent publishes changes
|
|
|
|
By default, the agent opens a pull request for every change so your team can review it before it ships. If Mintlify hosts your deployment, the agent commits changes directly to your deployment branch so changes publish immediately.
|
|
|
|
For deployments connected to your own Git provider, you can change how the agent publishes changes in the **Review process** setting on the [Agent](https://app.mintlify.com/products/agent) page of your dashboard:
|
|
|
|
- **Create a pull request**: The agent commits to a new branch and opens a pull request against your deploy branch. Use this option when you want a human to review changes before they publish.
|
|
- **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging deployment.
|
|
|
|
<Note>
|
|
If your deploy branch has branch protection rules that block direct pushes, the **Review process** setting is hidden and the agent always opens a pull request.
|
|
</Note>
|
|
|
|
## 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).
|
|
|
|
## Use AI tools alongside the agent
|
|
|
|
The agent works asynchronously through pull requests, but you can also use AI coding tools like Cursor or Claude Code locally for fast, iterative edits. Install the Mintlify [skill](/ai/skillmd) and connect the [MCP server](/ai/model-context-protocol) so your editor has the same context the agent uses.
|
|
|
|
To let an external agent edit your content directly through MCP tool calls, connect it to the [Mintlify MCP server](/ai/mintlify-mcp).
|
|
|
|
<SkillMcpPrompt />
|
|
|
|
## Next steps
|
|
|
|
<Card title="Connect Slack" horizontal icon="slack" href="/agent/slack">
|
|
Add the agent to your Slack workspace.
|
|
</Card>
|
|
<Card title="Customize behavior" horizontal icon="wrench" href="/agent/customize">
|
|
Configure the agent with an `AGENTS.md` file.
|
|
</Card>
|
|
<Card title="Write effective prompts" horizontal icon="pen" href="/agent/effective-prompts">
|
|
Get better results with focused prompts.
|
|
</Card>
|
|
<Card title="Automate with automations" horizontal icon="refresh-cw" href="/automations/index">
|
|
Automate recurring tasks and documentation maintenance with automations.
|
|
</Card>
|