A README checker that compares directory documentation with the files and folders that actually exist. A README is a project guide commonly placed in a repository.

It scans all READMEs or a chosen path and can apply safe corrections, while proposing new README files for review.

It catches stale file lists, incorrect descriptions, and important directories that lack documentation.

repo-readme — Skill for Claude Code and Codex by rjwalters/kicad-tools

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.

Any agent

npx skills add rjwalters/kicad-tools --skill repo-readme

Clone the repo

git clone --depth 1 https://github.com/rjwalters/kicad-tools

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/skills/rjwalters/kicad-tools/repo-readme/github.svg)](https://agentmods.dev/skills/rjwalters/kicad-tools/repo-readme)

Your own site

<a href="https://agentmods.dev/skills/rjwalters/kicad-tools/repo-readme"><img src="https://agentmods.dev/badge/skills/rjwalters/kicad-tools/repo-readme/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/skills/rjwalters/kicad-tools/repo-readme"><img src="https://agentmods.dev/badge/skills/rjwalters/kicad-tools/repo-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 15 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 1,230 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00015	$0.01230
Opus 5.5	$0.00006	$0.00492
Sonnet 5.5	$0.00003	$0.00246
Haiku 4.5	$0.00002	$0.00123

Measured 8d ago against content hash e280bd6b899a, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

repo-readme 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 8d 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.

.agents/skills/repo-readme/SKILL.md · 113 lines

How it starts

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

Codex form of the /repo:readme command. Other commands appear as $repo-<verb> skills. Helper scripts and .claude/ paths below are relative to the repository root and exist when the Claude Code surface is installed alongside this one.

$repo-readme — README Check

Validate that READMEs accurately describe the directories they live in. Catches stale file trees, incorrect descriptions, and missing READMEs in significant directories.

This is the README-structure layer of [[docs]]. Use it directly when that's all you want to check; use [[docs]] for the full documentation sweep.

Usage

$repo-readme                    # Scan all READMEs in repo
$repo-readme packages/core      # Scope to one subtree
$repo-readme docs/README.md     # Check a specific README
$repo-readme --ask              # Review findings and confirm before applying

By default, apply the safe, reversible fixes as you find them — updating stale listings, correcting wrong annotations — and report each change (they're all git-reversible). Run with --ask to review first: present the findings and confirm before touching anything. Writing a brand-new README is a judgment call, so it's always proposed, never written unattended, in either mode.

What It Checks

1. File Tree Accuracy

If a README contains an ASCII file tree (... block with ├── or └──), compare it against the actual directory listing:

Files/dirs listed in README but missing on disk
Files/dirs on disk but not listed in README
Descriptions that are factually wrong (e.g., "gitignored" when it's tracked)

2. Missing READMEs

GitHub renders a directory's README.md right below its file listing, so a README at each level a person browses to makes the repo read as documented instead of a bare file dump. Flag directories that a human would actually navigate to in the web UI and that lack one, scaled by how significant the directory is:

Read the full file on GitHub · 113 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.

8d ago First seen · 113 lines · 15 tokens per session scan A e280bd6b899a

Subscribe to this mod's changes

repo-readme is a skill published in the GitHub repository rjwalters/kicad-tools (73 stars, last pushed yesterday), licensed MIT. It adds 15 tokens to every session and 1,230 once invoked, about $0.0001 per session on Opus 5.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-11-01.

Writing and docs

repo-readme next to 6 skills from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
repo-readmerjwalters/kicad-tools	Skill	73	yesterday	MIT	A	15	Claude Code, Codex
imagegenopenai/codex	Skill	134k	today	Apache-2.0	A	113	Codex
local-ai-agentsmicrosoft/ai-agents-for-beginners	Skill	79k	2d ago	MIT	A	200	Claude Code, Codex
playwright-climicrosoft/playwright	Skill	100k	today	Apache-2.0	A	19	Claude Code
browser-automationopenclaw/openclaw	Skill	394k	today	MIT	A	36	Claude Code
systematic-debuggingobra/superpowers	Skill	315k	5d ago	MIT	A	21	Claude Code
next-cache-components-adoptionvercel/next.js	Skill	143k	yesterday	MIT	A	95	Claude Code