readme-critique

readme-critique is a skill for Claude Code from getkyo/kyo. It costs 65 tokens per session (3,276 once invoked), scanned A, original, Apache-2.0.

A whole-document review step for README files that checks whether they teach the reader how a project works rather than merely listing features. It examines the document’s structure, examples, explanations, and overall reading experience.

In plain words
What is it for?
Use it after drafting or editing a README and before verification. It evaluates the opening example, organization, practical explanations, and whether the document connects related ideas instead of presenting disconnected lists.
Why use it?
Basic checks can confirm that names and sections are present while missing a README that is technically complete but difficult to learn from. This review catches that gap before final verification.

Skill for Claude Code

Written for Claude Code: argument-hint in frontmatter. Also seen: mentions subagents.

Good fit Use it after drafting or editing a README and before verification. It evaluates the opening example, organization, practical explanations, and whether the document connects related ideas instead of presenting disconnected lists.

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

Made for: Claude Code.

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-critique

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/getkyo/kyo/readme-critique"><img src="https://agentmods.dev/badge/skills/getkyo/kyo/readme-critique.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 65 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,276 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.00065 $0.03276
Opus 5 $0.00032 $0.01638
Sonnet 5 $0.00013 $0.00655
Haiku 4.5 $0.00006 $0.00328

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

Security

Grade A, and why

readme-critique 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 9d 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.

.claude/skills/readme-critique/SKILL.md · 222 lines

How it starts

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

readme-critique

The verify gates check coverage (Gate 4), self-consistency (Gates 1-2), and skim-experience (Gate 3). They pass on READMEs that are internally consistent and complete-by-name but that read as catalogs rather than teaching. This skill is the gestalt judge that the verify gates cannot be.

readme-critique runs AFTER readme-draft (or after readme-edit) and BEFORE readme-verify. Its job: read the candidate top to bottom as a real reader would, and report along eight axes whether the README teaches or merely lists.

Inputs

  • readme_path: the candidate README.
  • source_analysis_path: the analyzer's output (includes the section-cluster output and the running-domain seeds — this is the contract the draft was supposed to follow).
  • exemplar_path (optional): a reference README to compare against (typically git show origin/main:<module>/README.md for kyo modules).

The eight axes

For each axis, report PASS | WEAK | FAIL with line evidence.

Axis 1: Opening hook size and shape

Count the lines of the first fenced scala block in the README (the opening hook, between the opening and closing triple-backticks). It must be ≤15 lines and demonstrate ONE compelling thing on ONE running value. Or: no opening code block at all (spine prose alone hooks the reader). Comprehensive multi-capability examples belong in a ## Putting it together (or similar) section near the END of the README, after the cluster sections.

  • PASS: ≤15-line opening block doing one verb on one value, OR no opening code block at all (spine paragraphs only).
  • WEAK: 16-25 line opening block, OR a smaller block but with two unrelated capabilities crammed in.
  • FAIL: 26+ line opening block, OR multi-capability "tour of the module" with // section heading comments dividing sub-blocks at the top.

Rationale: walls of code at the top get skimmed past or close the README entirely. A short hook gets the reader committed; the comprehensive composition example survives, but moves to a final section where motivated readers will find it.

Read the full file on GitHub · 222 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. 9d ago First seen · 222 lines · 65 tokens per session scan A bcc55735b003

Subscribe to this mod's changes

readme-critique is a skill published in the GitHub repository getkyo/kyo (812 stars, last pushed yesterday), licensed Apache-2.0. It adds 65 tokens to every session and 3,276 once invoked, about $0.0003 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

systematic-debugging

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

obra/superpowers · 21 tokens

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

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

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

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens