Skip to main content

Tools

Each PR-Agent tool has a dedicated page that explains its behavior and usage:

ToolDescription
PR Description (/describe)Generate a PR title, type, summary, code walkthrough and labels.
PR Review (/review)Generate a PR review with feedback on possible issues, security concerns, tests and review effort.
Code Suggestions (/improve)Generate actionable code suggestions for improving the PR.
Question Answering (/ask ...)Answering free-text questions about the PR, or on specific code lines
Add Documentation (/add_docs)Generate documentation for code components that are missing it
Generate Labels (/generate_labels)Generate custom labels for the PR based on the code changes
Similar Issues (/similar_issue)Find similar issues in the repository based on the current issue
Help (/help)Provides a list of all the available tools
Help Docs (/help_docs)Answer a free-text question based on a git documentation folder
Update Changelog (/update_changelog)Automatically updating the CHANGELOG.md file with the PR changes

Usage examples​

Each tool can be triggered in two ways:

  • As a comment — write the command (e.g. /review) as a comment, and PR-Agent replies. Most tools are commented on a PR; issue-scoped tools such as similar_issue are commented on an issue.
  • From the CLI — run python -m pr_agent.cli --pr_url=<PR_URL> <tool>. Issue-scoped tools take --issue_url=<ISSUE_URL> instead of --pr_url. The module form works only from an environment where the pr_agent package is importable (for example, the venv created by uv sync). If pr-agent is on your PATH, run it directly.

Both accept the same tool arguments and configuration overrides.

ToolCommentCLI
Describe/describepython -m pr_agent.cli --pr_url=<PR_URL> describe
Review/reviewpython -m pr_agent.cli --pr_url=<PR_URL> review
Improve/improvepython -m pr_agent.cli --pr_url=<PR_URL> improve
Ask/ask "How does X work?"python -m pr_agent.cli --pr_url=<PR_URL> ask "How does X work?"
Add Docs/add_docspython -m pr_agent.cli --pr_url=<PR_URL> add_docs
Generate Labels/generate_labelspython -m pr_agent.cli --pr_url=<PR_URL> generate_labels
Similar Issues/similar_issuepython -m pr_agent.cli --issue_url=<ISSUE_URL> similar_issue
Help/helppython -m pr_agent.cli --pr_url=<PR_URL> help
Update Changelog/update_changelogpython -m pr_agent.cli --pr_url=<PR_URL> update_changelog

/help_docs is temporarily disabled (see #2445) and is therefore omitted from the table above.

For screenshots, arguments, and a walkthrough of a typical use case, see the Example usage section on each tool's page linked above.