visual-recap
Generate and maintain the system recap block in a PR description - a GitHub-rendered visual summary of which system primitives a change touches, how risky it is, and what changed. Prefer mermaid sequence diagrams for the change; pick another graph type when it explains the diff better. Use when planning a non-trivial change (plan mode), when creating or updating a pull request (recap mode), or when the user asks for a visual recap, visual plan, system review, or PR recap.
How do I install this agent skill?
npx skills add https://github.com/kentcdodds/kcd-skills --skill visual-recapIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides a set of scripts used to generate and maintain a visual recap of system changes within GitHub Pull Requests. It uses local git commands and the GitHub CLI to update PR descriptions with Mermaid diagrams. All identified scripts and behaviors are well-scoped developer tools that operate on the local repository or through standard GitHub integration points, with no suspicious network activity, credential harvesting, or obfuscation detected.
- Socketpass
No alerts
- Snykwarn
Risk: MEDIUM · 1 issue
What does this agent skill do?
System recap
When a change is non-trivial (a plan, a PR create or update, or a request for a visual recap), put one marker-delimited block in the PR description. GitHub renders it. It does not replace reading the diff.
When
Recap mode reads the diff, not memory. Claims about what changed must be
checkable against git diff <base>...HEAD (plus --stat). Session context may
explain intent only.
Run the classifier. Roll up to the highest of adds, then extends, then
composes. You still choose composes vs extends from the diff. adds is a
new map entry.
| Rollup | Risk | Also |
|---|---|---|
composes | low | Wiring and call sites only. |
extends | medium | Verify locally with the project's control CLI as the seeded user; a PR preview only when local cannot |
adds | high | Update primitives.yaml, run check-primitives-map.mjs, and the same local verify (preview when needed) |
Update primitives.yaml when this PR adds, removes, or materially reshapes a
primitive (new id, renamed meaning, or ownership roots that must change). Do
not edit summary for ordinary feature work. Call out a touched invariant from
that map at every risk.
Keep each entry's adrs in sync: list the current decision records that shape
the primitive (adrs: [] if none), and when this PR adds or supersedes a
record, add it to (or swap it into) the matching entries. The classifier prints
each touched primitive's adrs; read them before you change that primitive. The
check script fails on missing or superseded paths.
Plan mode uses **Mode:** plan before a PR exists. Recap mode replaces that
block from git diff <base>...HEAD. In plan mode, say explicitly when the plan
requires no change to any primitive; that is the lowest-risk outcome.
The block shape is one example: references/block-format.md.
Command
node .agents/skills/visual-recap/scripts/classify-primitives.mjs --base <base> --head HEAD --json
node .agents/skills/visual-recap/scripts/upsert-recap-block.mjs <pr-number> <block-file>
node .agents/skills/visual-recap/scripts/check-primitives-map.mjs
The upsert script checks mermaid, then replaces the marker block or appends it. It does not edit text outside the markers. Re-run both commands after a significant push.
Failure
- The mermaid check exits non-zero. Fix the diagram. Keep
;out of sequence notes and messages. - The block file must start with
<!-- system-recap:start -->and end with<!-- system-recap:end -->. gh pr editfails withResource not accessible by integration (updatePullRequest). The script still prints the merged body. Apply that body with Cursor ManagePullRequest. Do not have Kody edit the PR.- A health check or login smoke is not medium or high verification. Prefer local control CLI proof; use a preview only when local cannot exercise the change. Do not cat the session cookie into curl or Python.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/kentcdodds/kcd-skills/visual-recap">View visual-recap on skillZs</a>