review-readme

review-readme is a skill for Claude Code, Codex from tomzx/agents. It costs 24 tokens per session (1,206 once invoked), scanned A, original, MIT.

A README review workflow that checks a project's main introductory document for required sections, accuracy, completeness, clarity, and ease of getting started. A README is the documentation page commonly shown first in a code repository.

In plain words
What is it for?
Use it to review a README against the project files, its license, package configuration, and the expected README template.
Why use it?
It catches misleading instructions, missing setup information, template problems, and unclear paths for new users.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to review a README against the project files, its license, package configuration, and the expected README template.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/tomzx/agents/review-readme
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 tomzx/agents --skill review-readme
Clone the repo
git clone --depth 1 https://github.com/tomzx/agents

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.

agentmods badge for review-readme

README.md
[![agentmods](https://agentmods.dev/badge/skills/tomzx/agents/review-readme/github.svg)](https://agentmods.dev/skills/tomzx/agents/review-readme)
Your own site
<a href="https://agentmods.dev/skills/tomzx/agents/review-readme"><img src="https://agentmods.dev/badge/skills/tomzx/agents/review-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.

agentmods 80×15 button for review-readme

Your own site · 80×15
<a href="https://agentmods.dev/skills/tomzx/agents/review-readme"><img src="https://agentmods.dev/badge/skills/tomzx/agents/review-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 24 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,206 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00024 $0.01206
Opus 5.5 $0.00010 $0.00482
Sonnet 5.5 $0.00005 $0.00241
Haiku 4.5 $0.00002 $0.00121

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

Security

Grade A, and why

review-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 22d 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/review-readme/SKILL.md · 131 lines

How it starts

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

Review README

Audits a README.md and reports findings across six categories: template conformance, accuracy, completeness, clarity, usability, and hygiene. Each finding is prioritized with 🔴 MUST fix, 🟡 SHOULD fix, or 🟢 MAY fix.

/review-documentation audits the wider documentation tree. This skill handles the README specifically: it checks the fixed README template, badge correctness, and the getting-started path, which the general documentation review does not cover in depth.

Prerequisites

  • A README.md provided in context or as a file path to read
  • The project it describes (source tree, LICENSE, package manifest such as go.mod, package.json, Cargo.toml, or pyproject.toml) for the accuracy checks
  • The README template from create-readme, for the conformance checks

Steps

  1. Read the README thoroughly.
  2. Read the project's LICENSE, package manifest, and, when needed, the source tree to verify claimed values.
  3. Identify issues in each category below.
  4. Prioritize each finding: 🔴 MUST, 🟡 SHOULD, 🟢 MAY.
  5. Report findings using the output format. Omit categories with no findings.

Review Checklist

Template Conformance

  • Are the required sections present and in order (header, What, Why, Included, Roadmap, Out of Scope, Requirements, Install, Getting Started, License)?
  • Is the centered header present with the repository name and one-sentence description?
  • Do the badges follow the template and derive from actual values (license, language and version, platform), with inapplicable badges removed?
  • Are sections the template allows to be omitted (Roadmap, Out of Scope, Values-style optional sections) omitted rather than left empty?

Accuracy

  • Do the license badge and License section match the actual LICENSE?
  • Do the language and version badges match the package manifest?
  • Do platform and storage claims match the build targets and dependencies?
  • Are links (badges, license, docs) valid and pointing at actual targets?
  • Are install and usage commands runnable as written?

Read the full file on GitHub · 131 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. 22d ago Changed · -7 lines 866adbbdf06f
  2. 25d ago Changed b6b08648aae2
  3. 28d ago First seen · 138 lines · 24 tokens per session scan A 84ecedbf3fb9

Subscribe to this mod's changes

review-readme is a skill published in the GitHub repository tomzx/agents (13 stars, last pushed yesterday), licensed MIT. It adds 24 tokens to every session and 1,206 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-10-01.

Related

Other skills, from other repositories

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

systematic-debugging

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

obra/superpowers · 21 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 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

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens