-
Notifications
You must be signed in to change notification settings - Fork 218
Add agent v2 documentation #3416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,164 @@ | ||||||||||
| --- | ||||||||||
| title: "Agent v2" | ||||||||||
| description: "Claude-powered autonomous documentation agent for creating, updating, and maintaining your documentation." | ||||||||||
| keywords: ["agent v2", "automation", "AI", "claude", "autonomous", "documentation"] | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| <Info> | ||||||||||
| Agent v2 is available on [Enterprise plans](https://mintlify.com/pricing?ref=agent) and is powered by Anthropic's Claude 4.5 Sonnet model. | ||||||||||
|
Check warning on line 8 in agent/agent-v2.mdx
|
||||||||||
| </Info> | ||||||||||
|
|
||||||||||
| Agent v2 is an autonomous technical writer powered by Claude 4.5 Sonnet. It creates pull requests with documentation changes based on your prompts, references your codebase and Slack conversations, and follows technical writing best practices. | ||||||||||
|
|
||||||||||
| ## Core capabilities | ||||||||||
|
|
||||||||||
| The agent can: | ||||||||||
|
|
||||||||||
| - **Write new documentation**: Create pages from scratch based on prompts, pull requests, or Slack threads | ||||||||||
| - **Update existing content**: Search and revise documentation to keep it current | ||||||||||
| - **Review code changes**: Reference connected repositories to document new features or API changes | ||||||||||
| - **Answer questions**: Provide information about your docs and technical writing best practices | ||||||||||
| - **Maintain consistency**: Follow your documentation style and Mintlify schema automatically | ||||||||||
|
|
||||||||||
| ## How the agent works | ||||||||||
|
|
||||||||||
| When you send a request, the agent: | ||||||||||
|
|
||||||||||
| 1. **Researches**: Reads your existing documentation, connected repositories, and relevant context | ||||||||||
| 2. **Plans**: Creates a structured task list for complex documentation work | ||||||||||
| 3. **Writes**: Generates or updates content following technical writing standards | ||||||||||
| 4. **Validates**: Runs Mintlify CLI checks to ensure documentation builds correctly | ||||||||||
| 5. **Creates PR**: Opens a pull request with proposed changes for human review | ||||||||||
|
|
||||||||||
| All changes go through pull requests. The agent never commits directly to your main branch. | ||||||||||
|
|
||||||||||
| ## Tools and capabilities | ||||||||||
|
|
||||||||||
| The agent has access to specialized tools for documentation work: | ||||||||||
|
|
||||||||||
| ### File operations | ||||||||||
| - **Read**: Access any file in your repository with line number references | ||||||||||
| - **Edit**: Make precise changes to existing documentation | ||||||||||
| - **Write**: Create new documentation pages | ||||||||||
| - **Search**: Find files by pattern (glob) or content (grep) | ||||||||||
|
|
||||||||||
| ### Git and GitHub | ||||||||||
| - **Branch management**: Create and switch branches | ||||||||||
| - **Commit changes**: Stage and commit updates with descriptive messages | ||||||||||
| - **Pull requests**: Open PRs with clear descriptions using `gh` CLI | ||||||||||
|
||||||||||
| - **Pull requests**: Open PRs with clear descriptions using `gh` CLI | |
| - **Pull requests**: Open PRs with clear descriptions |
Check warning on line 54 in agent/agent-v2.mdx
Mintlify / Mintlify Validation (mintlify) - vale-spellcheck
agent/agent-v2.mdx#L54
Use 'Dev' instead of 'dev'.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These two bullets read like continuations; making them consistent with the rest of the list improves scanability.
| - Prevents goal drift during complex updates | |
| - Provides visibility into what's being worked on | |
| - **Goal alignment**: Prevents goal drift during complex updates | |
| - **Visibility**: Provides visibility into what's being worked on |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section title says AGENTS.md, but the content points to .claude/CLAUDE.md (and later the page repeats that). That seems inconsistent with /agent/customize, which documents AGENTS.md.
| Customize the agent's behavior by adding a `.claude/CLAUDE.md` file to your repository root. This file defines: | |
| Customize the agent's behavior by adding an `AGENTS.md` file to your repository. This file defines: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keyboard shortcut formatting: docs elsewhere use the key name vs the symbol, and spaces around + read better.
| - **Dashboard**: Press <kbd>⌘</kbd>+<kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) from any dashboard page | |
| - **Dashboard**: Press <kbd>Command</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux) from any dashboard page |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Style: the ✅/❌ markers can render inconsistently across platforms/themes. Consider using plain labels.
| ❌ "Update the docs" | |
| Bad: "Update the docs" | |
| Good: "Add a section to /api-playground/overview explaining how to add authentication headers to API requests" |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,6 +4,10 @@ | |||||
| keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] | ||||||
| --- | ||||||
|
|
||||||
| <Warning> | ||||||
| This documentation describes agent v1, which is deprecated. Please refer to [agent v2](/agent/agent-v2) for the latest version powered by Claude 4.5 Sonnet with enhanced capabilities and autonomous planning. | ||||||
|
||||||
| This documentation describes agent v1, which is deprecated. Please refer to [agent v2](/agent/agent-v2) for the latest version powered by Claude 4.5 Sonnet with enhanced capabilities and autonomous planning. | |
| This documentation describes agent v1, which is deprecated. Please refer to [agent v2](/agent/agent-v2) for the latest version with enhanced capabilities and autonomous planning. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,6 +78,7 @@ | |
| { | ||
| "group": "Agent", | ||
| "pages": [ | ||
| "agent/agent-v2", | ||
| "agent/index", | ||
| "agent/quickstart", | ||
| "agent/slack", | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: since the underlying model may change, it might be safer to phrase this as “currently powered by …”.