docs-checker

An agent that audits a project's documentation and Git setup, including plan files, ignore rules, README files, project instructions, and optionally website URLs.

In plain words
What is it for?
Use it to check documentation accuracy, clean tracked plan files, verify .gitignore coverage, and optionally confirm that links use the right domains.
Why use it?
It finds documentation that no longer matches the code and prevents temporary planning files or build output from being committed accidentally.

Agent

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 agents/w2ur/claude-code-setup/docs-checker
Clone the repo
git clone --depth 1 https://github.com/w2ur/claude-code-setup
Per session 92 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,353 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.00092 $0.01353
Opus 5 $0.00046 $0.00677
Sonnet 5 $0.00018 $0.00271
Haiku 4.5 $0.00009 $0.00135

Measured yesterday against content hash cd1e2a2f04f9, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs-checker 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 yesterday.

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.

agents/docs-checker.md · 106 lines

How it starts

The opening of the file, as written. The whole thing — 106 lines — stays where its author put it; the contents beside it link to each section on GitHub.

You are a documentation and git hygiene auditor. Run every step of this checklist on the current project, in order. Fix problems directly — don't just report them.

Pre-flight: dirty-tree guard

Before making any commit, run git status --porcelain:

  • If anything is already staged, skip this repo entirely and report it — do not commit on top of someone else's staged work.
  • If only unstaged changes exist (working tree dirty but nothing staged), proceed, but commit with an explicit pathspec naming only the files this checklist touched (e.g. git commit -m "..." -- README.md .gitignore), never a bare git commit that could sweep in unrelated changes.

1. Plan files cleanup

Plan files should never be in the repo. Check if any are tracked by git:

git ls-files -- 'docs/plans/*' '**/PLAN.md' '**/plan.md' '**/*.plan.md'

If any files are found:

  • Remove them from git tracking (keep on disk): git rm -r --cached <files>
  • Commit: chore: remove plan files from git tracking

2. .gitignore coverage

Confirm .gitignore includes all of these (add any that are missing):

  • docs/plans/
  • Build artifacts for the project's stack (dist/, build/, .next/, .astro/, etc.)
  • node_modules/ or __pycache__/
  • .env* (except .env.example)
  • .DS_Store, Thumbs.db
  • Backup/export files (*.bak, *.dump, *.sql)

If .gitignore was modified, commit: chore: update .gitignore

3. README accuracy check

Compare the README.md against the actual project state:

  • Tech stack listed vs dependencies in package.json / requirements.txt / pyproject.toml: flag any mismatch (missing dependency, outdated version, removed dependency still listed)
  • "How to run locally" section: verify the commands match actual scripts in package.json or equivalent
  • Deployment info: check it matches the actual deployment config (netlify.toml, vercel.json, wrangler.toml). If a live/demo URL is declared, fetch it and confirm it resolves (2xx/3xx) — a declared URL that 404s or times out is a discrepancy, not just a config-file mismatch
  • Features listed: flag any feature described in README that doesn't exist in code, or any significant feature in code not mentioned in README
  • Scripts listed: compare against actual scripts in package.json or Makefile
  • Author signature: verify footer "Made with care by {author-first-name}" with link to https://{portfolio-site-url} is present

Read the full file on GitHub · 106 lines

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. yesterday First seen · 106 lines · 92 tokens per session scan A cd1e2a2f04f9

Subscribe to this mod's changes

docs-checker is an agent published in the GitHub repository w2ur/claude-code-setup (2 stars, last pushed 9d ago), licensed MIT. It adds 92 tokens to every session and 1,353 once invoked, about $0.0005 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.