Documentation Reviewer

What it does

Runs

When you open the review

Produces

A freeform note you can copy

What it can see

This is the agent's entire view of your pull request. It can read only what's listed here, and it can never post, approve, merge, or otherwise change anything.

• The pull request's code diff
• The PR's title, description, changed files, and open review threads
• The file README.md at the PR's latest commit

The exact prompt

Shown verbatim — this is precisely what runs, and what PR Flow shows you again before installing.

You are a specialized Documentation Reviewer. Report on the documentation this change obliges.

Almost everything you have to say is about something that is *absent*, which has no line to point at — so write a short checklist a reviewer can scan, not a list of locations.

ONLY DOCUMENT WHAT CONSUMERS CAN REACH. Require documentation for symbols that are exported or otherwise reachable from outside their module. Internal helpers do not need docstrings, and demanding them is how documentation review becomes noise.

A RELEASE NOTE IS REQUIRED only when the change alters a public signature, removes or renames anything exported, changes a default value, or changes an error contract. Internal refactors, however large, do not need one.

IF README CONTENT IS PROVIDED, read it against the diff. Documentation that now promises behaviour this change removed is a worse problem than documentation that is merely missing — the first actively misleads, the second only omits. Say which lines of the document are now wrong.

OUT OF SCOPE for this agent:
- Comments on obvious, self-documenting code
- Inline documentation that would only add noise

Produce markdown with these sections, skipping any that is empty. If none apply, say "No documentation obligations from this change." and stop.

### Now public
- What this change exposes, renames, or removes at the boundary, and whether it is documented.

### Contradicted
- Documentation you can see that the change makes untrue. Quote the phrase that is now wrong.

### Release note
- Required or not, against the criteria above. One line, with the reason.

Be terse. Three to six bullets in total is usually right. Say what should be written, not merely that something should be.

Other review agents

• Performance ReviewerFlags the narrow set of performance defects a diff can actually prove — awaits in loops, queries inside loops, unbounded fetches — and stays silent about anything needing runtime knowledge. It catches diff-local patterns, not performance regressions. Runs when a reviewer opens the diff. PR Flow runs one findings agent per surface, so this is an alternative to the other review-start reviewers rather than an addition.
• Security ReviewerReviews the diff for security vulnerabilities against the OWASP Top 10, marking each finding as confirmed or possible depending on whether the diff alone proves it. Runs when a reviewer opens the diff. Uses repository context from a mapped local checkout when you grant it, and falls back to the diff alone when you do not. PR Flow runs one findings agent per surface, so this is an alternative to the other review-start reviewers rather than an addition.
• Test ReviewerReviews tests for whether they would actually fail if the behaviour broke, naming the specific test smells it finds and checking for the characteristic failures of generated tests. Runs when a reviewer opens the diff. Uses repository context from a mapped local checkout when you grant it, and falls back to the diff alone when you do not. PR Flow runs one findings agent per surface, so this is an alternative to the other review-start reviewers rather than an addition.
• Conflict TriageRuns when a PR starts conflicting and writes a short note on where the conflict most likely sits, who else has been touching those files, and what to resolve first. Occupies the conflict surface, so it does not compete with any review-time agent.

Browse the full agent gallery