adr

A documentation tool for recording important software design decisions as numbered Architecture Decision Records (ADRs). It creates a Markdown file in the project's `docs/adr/` folder.

In plain words
What is it for?
Use it when choosing between technical approaches, documenting alternatives, or updating design documentation after a decision.
Why use it?
It keeps the reasons behind technical choices alongside the code, so future developers can understand what was decided and why. Automatic numbering avoids manually tracking ADR filenames.

Skill for Claude CodeCodex

Part of the swf plugin — 16 skills, 1 agent shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/cliffren/swf/adr
Any agent
npx skills add cliffren/swf --skill adr
Clone the repo
git clone --depth 1 https://github.com/cliffren/swf

Made for: Claude Code, Codex.

Or install swf, the plugin that ships this one along with the rest of its 16 skills, 1 agent.

Per session 15 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 450 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00015 $0.00450
Opus 5 $0.00008 $0.00225
Sonnet 5 $0.00003 $0.00090
Haiku 4.5 $0.00002 $0.00045

Measured 2d ago against content hash 9b96ac79ee95, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

adr scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/adr/SKILL.md · 68 lines

What it actually says

Write ADR

Create a new Architecture Decision Record in the project's docs/adr/ directory.

Input

$ARGUMENTS — the ADR title (e.g., "使用 sparse matrix 存储表达矩阵"). If not provided, ask.

Workflow

  1. Auto-number:

    • Scan docs/adr/ for existing ADRs
    • Next number = max existing + 1, zero-padded to 3 digits
  2. Gather context:

    • Ask the user:
      • What decision was made?
      • What alternatives were considered?
      • Why was this option chosen?
    • Read docs/design.md for related context
  3. Write the ADR:

    File: docs/adr/<NNN>-<slug>.md

    # ADR-<NNN>: <Title>
    
    **Date:** <today>
    **Status:** Accepted
    
    ## Context
    <What problem or question prompted this decision>
    
    ## Decision
    <What was decided>
    
    ## Alternatives Considered
    <Other options and why they were rejected>
    
    ## Consequences
    <What this means going forward — positive and negative>
    
    ## References
    <Links to issues, papers, docs if relevant>
    
  4. Commit:

    • git add docs/adr/<NNN>-<slug>.md
    • Commit with message: docs: add ADR-<NNN> <title>
  5. Prompt for design update:

    • Check if the decision affects docs/design.md
    • If yes: "这个决策影响到 design.md,要运行 /swf:update-design 更新吗?"

Rules

  • ADRs are append-only: never modify existing ADRs
  • If a decision supersedes a previous one, note it in Context and update the old ADR's status to "Superseded by ADR-NNN"
  • Must be run from within a project repo directory
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 68 lines · 15 tokens per session scan A 9b96ac79ee95

Subscribe to this mod's changes

adr is a skill published in the GitHub repository cliffren/swf (5 stars, last pushed 4mo ago), licensed MIT. It adds 15 tokens to every session and 450 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens