readme-review

readme-review is a skill for Claude Code, Codex from navikt/copilot. It costs 35 tokens per session (1,663 once invoked), scanned A, original, MIT.

A guide for reviewing or creating README files according to the kind of software project they describe. A README is the main introductory document for a code repository, and a monorepo is one repository containing multiple applications or packages.

In plain words
What is it for?
Identifying the README’s scope, reviewing an existing README, generating a new one, and routing language-quality issues to a separate writing tool.
Why use it?
It helps ensure the document has the right sections, order, and level of detail for a service, library, monorepo, scheduled job, or documentation-only project. It also separates document structure from language editing.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions AGENTS.md.

Good fit Identifying the README’s scope, reviewing an existing README, generating a new one, and routing language-quality issues to a separate writing tool.

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

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 readme-review

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/navikt/copilot/readme-review"><img src="https://agentmods.dev/badge/skills/navikt/copilot/readme-review.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 35 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,663 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. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.00035 $0.01663
Opus 5 $0.00017 $0.00831
Sonnet 5 $0.00007 $0.00333
Haiku 4.5 $0.00003 $0.00166

Measured 8d ago against content hash 6c4314c7b44a, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-12, from the pricing page.

Security

Grade A, and why

readme-review 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.

skills/readme-review/SKILL.md · 189 lines

How it starts

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

README Review & Scaffold

Structural review and generation of READMEs adapted to project type. Complements @forfatter (language quality) with structural guidance (what sections, what order, what depth).

Workflow

Step 0: Detect README scope
Step 1: Route → review or generate
Step 2a: Review existing README
Step 2b: Generate new README
Step 3: Hand off language issues to @forfatter

Step 0: Detect README scope

Before reviewing or generating, determine what kind of README this is. Use file location and nearby manifests:

Scope Signals Example
Monorepo root Root README.md, multiple apps/ or packages/, workspace config navikt/fp-sak/README.md with apps/ dir
Service / API .nais/ dir, main.go / Application.kt, Dockerfile apps/my-service/README.md
Library / package Published to npm/Maven, no .nais/, exports public API libs/shared-utils/README.md
Naisjob .nais/naisjob.yaml, scheduled execution, no HTTP endpoints apps/batch-processor/README.md
Docs-only No source code, only markdown files docs/README.md

If scope is unclear, ask the user.

Step 1: Route

  • Existing README + user says "review", "check", "improve" → Step 2a
  • No README or user says "create", "scaffold", "generate" → Step 2b
  • Ambiguous → check if README.md exists in the target directory

Step 2a: Review existing README

2a.1 Check sections against spec

Read the existing README. For each section in the spec for this project type (see section-spec.md):

Status Meaning
✅ OK Section exists with substantive content
⚠️ Weak Section exists but is thin, outdated, or misplaced
❌ Missing Required section is absent
Section not applicable for this project type

2a.2 Check for anti-patterns

Scan for structural anti-patterns (see anti-patterns.md). Flag only patterns that are actually present.

Read the full file on GitHub · 189 lines

Files

What ships with it

7 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 8d ago Changed 6c4314c7b44a
  2. 12d ago First seen · 189 lines · 35 tokens per session scan A 36fe844fd272

Subscribe to this mod's changes

readme-review is a skill published in the GitHub repository navikt/copilot (54 stars, last pushed yesterday), licensed MIT. It adds 35 tokens to every session and 1,663 once invoked, about $0.0002 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-30.

Related

Other skills, from other repositories

skill-guide

Design, write, and review SKILL.md files using proven patterns. Use when creating, improving, or reviewing agent skills, choosing a design pattern (Tool Wrapper, Generator, Reviewer, Inversion, Pipeline), structuring progressive disclosure, writing skill descriptions, or composing patterns. Also trigger for 'skill…

AndyElessar/skills · 102 tokens

microsoft-webui

Microsoft WebUI Framework expertise — a language-agnostic server-side rendering framework where templates compile to a binary protocol and interactive Web Components hydrate as islands. Use when authoring, reviewing, or debugging WebUI components (.html + .css + .ts triplets), wiring up routes, hydrating with…

AndyElessar/skills · 212 tokens

plugin-creator

Guide AI agents through creating GitHub Copilot CLI and Claude Code plugins and plugin marketplaces — from scaffolding plugin directories and writing plugin.json manifests to building marketplace.json registries and testing installations. Use this skill whenever the user wants to create, scaffold, configure, package…

AndyElessar/skills · 181 tokens

prose-guide

Guide AI-native development using the PROSE methodology — Progressive Disclosure, Reduced Scope, Orchestrated Composition, Safety Boundaries, Explicit Hierarchy. Use when: setting up AI-native projects, creating agent primitives (.instructions.md, .prompt.md, .agent.md, SKILL.md, .spec.md, AGENTS.md), designing…

AndyElessar/skills · 162 tokens

csharp-source-generator

Use when writing, reviewing, debugging, or testing C# source generators and Roslyn incremental generators. Covers IIncrementalGenerator architecture, SyntaxProvider pipelines, generated-code snapshots with Verify, analyzer packaging, marker attributes, AnalyzerConfigOptionsProvider, SDK compatibility, diagnostics, and…

AndyElessar/skills · 152 tokens

aspire-dev

Orchestrates Aspire distributed applications using the Aspire CLI and MCP tools. USE FOR: aspire start/stop, aspire describe, aspire doctor, view logs/traces, add integrations, debug resources, AppHost management. Also trigger for DistributedApplication.CreateBuilder, AddProject, AddContainer, or Aspire resource…

AndyElessar/skills · 146 tokens