docs: add ABP Studio AI Agent documentation#25565
Conversation
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 71.1%, saving 141.9 KB.
3 images did not require optimisation. |
There was a problem hiding this comment.
Pull request overview
This PR expands the ABP Studio documentation by introducing a new “AI Agent” documentation set (overview + configuration + workflows + capabilities + Git integration + coding guide), updates the Studio overview to reflect the renamed feature, and wires the new section into the docs navigation flow.
Changes:
- Added a new ABP Studio “AI Agent” documentation section with multiple reference pages and screenshots.
- Updated ABP Studio overview content to replace “AI Assistant” with “AI Agent” and link to the new reference docs.
- Updated docs navigation to include the new AI Agent section and adjusted next-page navigation.
Reviewed changes
Copilot reviewed 9 out of 14 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/studio/overview.md | Renames AI Assistant to AI Agent in the overview and links to the new AI Agent reference. |
| docs/en/studio/monitoring-applications.md | Updates doc-nav “Next” to point to the new AI Agent section. |
| docs/en/studio/coding-with-ai-agent.md | Adds a new page describing how to work effectively with the AI Agent for coding tasks. |
| docs/en/studio/ai-agent.md | Adds the AI Agent overview/reference page (modes, sessions, scopes, attachments, etc.). |
| docs/en/studio/ai-agent-configuration.md | Adds configuration reference (models, limits, permissions, rules/lessons, MCP servers). |
| docs/en/studio/ai-agent-workflows.md | Adds workflow reference (before/after tasks, analysis/build behavior, plan integration). |
| docs/en/studio/ai-agent-built-in-capabilities.md | Adds a capability matrix and tool-surface documentation per mode. |
| docs/en/studio/ai-agent-git-integration.md | Adds Git/A I Review integration reference and handoff workflows. |
| docs/en/docs-nav.json | Adds the AI Agent section to the ABP Studio docs navigation tree. |
| ## ABP Studio MCP Bridge | ||
|
|
||
| The ABP CLI includes `abp mcp-studio`, a stdio bridge for external AI tools. The command forwards JSON-RPC MCP messages to ABP Studio's local MCP endpoint and requires ABP Studio to be running. | ||
|
|
||
| Default endpoint: | ||
|
|
||
| ```text | ||
| http://localhost:38280/mcp/ | ||
| ``` |
| { | ||
| "mcpServers": { | ||
| "abp-studio": { | ||
| "command": "abp", | ||
| "args": ["mcp-studio"] | ||
| } | ||
| } | ||
| } |
|
|
||
| ## AI Review Handoff | ||
|
|
||
| AI Review is a review workflow, not an implementation workflow. After suggestions are produced, send the review content to ABP Agent when the intent is to apply fixes. |
|
|
||
| ## Sending Review Findings To The Agent | ||
|
|
||
| The Git panel can send review findings to ABP Agent. Studio builds a prompt that includes: |
|
|
||
| ## Merge Conflict Handoff | ||
|
|
||
| When unresolved merge conflicts exist, the Git panel can send the conflict list to ABP Agent. The generated prompt asks the agent to resolve conflicts and request clarification when the correct resolution is ambiguous. |
|
|
||
| ## GitHub Issue Handoff | ||
|
|
||
| GitHub issue details can be sent to ABP Agent from Studio when GitHub integration is connected. |
|
|
||
| ## GitHub Pull Request Handoff | ||
|
|
||
| Pull request details can be sent to ABP Agent when the current branch matches the PR branch. |
|
|
||
| Agent URL fetching can enrich GitHub URLs with issue or pull request information when GitHub integration is available. Pull request URL context can include review comments up to Studio's fetch limits. | ||
|
|
||
| This is separate from the explicit GitHub issue/PR "Send to ABP Agent" actions in the Git UI. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 12%, saving 2.3 KB.
3 images did not require optimisation. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 12.3%, saving 6.8 KB.
3 images did not require optimisation. |
Summary
Validation
docs/en/docs-nav.jsonsuccessfully.