What is the agent?

Learn how the Mintlify agent researches, plans, and writes documentation, then opens pull requests with proposed changes for your team to review.

The agent is available on Pro and Enterprise plans.

The agent is an AI tool that creates pull requests (or merge requests, for GitLab) 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.
• Creates a PR: Opens a pull request or merge request with proposed changes for review.

All changes go through pull requests or merge requests. The agent never commits directly to your deploy branch.

What you can do with the agent

Use the agent to:

• Write new content based on your prompts, pull requests, merge 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 GitHub repository that has the Mintlify GitHub App installed.
• 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.

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 page of the dashboard.

Connect repositories as context

The agent uses your existing deployment connection to read and write to your docs repository:

• GitHub: The agent uses the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel Settings or in the GitHub App settings.
• GitLab: The agent uses the GitLab integration that you set up for deployments. The agent opens merge requests against your deploy branch using the project access token you connected.

Additional source repositories that the agent references for context must be GitHub repositories with the Mintlify GitHub App installed.

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 and connect the MCP server 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.

Install the Mintlify skill and MCP servers for AI coding tools.

CopiedCopy promptOpen in Cursor

Next steps

Connect Slack

Add the agent to your Slack workspace.

Customize behavior

Configure the agent with an AGENTS.md file.

Write effective prompts

Get better results with focused prompts.

Automate with workflows

Automate recurring tasks and documentation maintenance with workflows.