The agent is available on Pro and Custom plans for anyone with access to your dashboard.
- Write new content based on your prompts, links to pull requests, or Slack threads
- Revise outdated code examples and API references
- Search and update existing content
- Answer questions about your docs and technical writing topics
@mintlify in a channel.
Add the agent to your Slack workspace
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it.
- Navigate to the agent page of your dashboard.
- Select the Connect button.
- Follow the Slack prompts to add the
mintlifyapp to your workspace. - Follow the Slack prompts to link your Mintlify account to your Slack workspace.
- Test that the agent is working and responds when you:
- Send a direct message to it.
- Mention it with
@mintlifyin a channel.
Connect repositories as context
The agent can only access repositories that you connect through the Mintlify GitHub App. Modify which repositories the agent can access in the GitHub App settings.Review and manage pull requests
After the agent completes a task, it responds with a link to the pull request it created. You can review the changes, leave comments, request modifications, or merge the PR directly from GitHub.Pull request workflow
- The agent creates a new branch with a descriptive name based on your prompt.
- All documentation changes are committed to this branch.
- A pull request is opened automatically with a summary of the changes.
- Review the PR in GitHub to see the full diff of all modified files.
- Merge the PR when you’re satisfied with the changes, or continue iterating with the agent in the Slack thread.
Request changes to a pull request
If the agent’s pull request needs adjustments, mention@mintlify in the same Slack thread with your feedback. The agent will update the existing pull request with new commits based on your instructions.
For example:
@mintlify The code example needs to use TypeScript instead of JavaScript@mintlify Add a note about rate limits to this section@mintlify Move the new section to appear before the authentication section
Close or abandon a pull request
If you no longer need the changes from an agent pull request, close it directly in GitHub. The agent will not reopen closed pull requests unless you create a new request.Embed the agent via API
Use the agent endpoints to create jobs, get a specific job, and get all jobs. Each job creates a pull request that you can manage through the GitHub API or web interface.Write effective prompts
Think of the agent as a helpful assistant that needs your guidance to complete tasks. Give it clear instructions and context. More focused tasks are easier to complete, so break down complex projects into smaller steps. Make your prompts specific and outcome-focused. Generic prompts like@mintlify Improve the onboarding page apply general best practices, but may not improve content in the specific way that you were picturing.
Try prompts based on outcomes you want your users to achieve or problems that they encounter. For example:
@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key
@mintlify Find and fix all typos in the docs@mintlify change all unordered lists to use * instead of -
Specify a subdomain
If you have multiple documentation sites with their own subdomains, include thesubdomain parameter in your message to specify which subdomain the agent should work on.
Use the format @mintlify subdomain=<your-subdomain> <your-prompt> to prompt the agent to work on a specific subdomain.
Examples:
@mintlify subdomain=public-docs Add a new section to the quickstart about inviting collaborators based on this PR: Prompts the agent to update the quickstart only on thepublic-docssubdomain.@mintlify subdomain=customer-docs Update the auth docs for the new authentication method: Prompts the agent to update the auth docs only on thecustomer-docssubdomain.
Agent workflows
The agent assists with many different documentation tasks. These workflows show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs.Iterate on a prompt in a Slack thread
Prompt the agent, then continue to mention it with@mintlify in the same thread to refine and iterate on the pull request that it creates.
For example: @mintlify Our quickstart page needs a new section on inviting collaborators. Then @mintlify The new section should be called "Inviting collaborators". Followed by any other iterations.
Start with the agent, finish manually
Prompt the agent to begin a project, then check out the branch it creates and finish the task in your local environment or the web editor. The agent can help you get started, then you can take over to complete the task. For example:@mintlify Update the quickstart page to include information about inviting collaborators and then checkout the branch to make any additional changes using your preferred method. The agent’s pull request will show both the agent’s commits and your manual commits together.
Update docs when merging feature changes
When you merge a feature pull request, share the PR link with the agent to update relevant docs. The agent will analyze the code changes in the pull request and create a new documentation pull request with the appropriate updates. For example:@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link]. The agent will read the pull request diff, understand the changes, and create a documentation PR that reflects the new authentication method.
Generate release notes from a pull request
Prompt the agent with a specific pull request to generate release notes or changelog updates based on the commit history. The agent will create a pull request that adds the release notes to your changelog or creates a new changelog entry. For example:@mintlify Generate release notes for this PR: [PR link]. The agent will analyze the pull request’s commits, changes, and description to create comprehensive release notes.
Generate code examples
Prompt the agent to generate code examples for features throughout your docs or on specific pages. For example:@mintlify Generate a code example to make the authentication method easier to understand.
Review existing content
Prompt the agent to review existing content for technical accuracy, style, grammar, or other issues. For example:@mintlify Review the API rate limiting section. We changed limits last month.
Respond to user feedback
Prompt the agent with feedback from your users to make focused updates to your docs. For example:@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?.