A guided workflow for writing or reviewing a README, the main instruction document for a software project. It coordinates several stages so the final document explains the project to interested readers without unnecessary sections.

Use it to create or rewrite a module README, analyze its source, draft the document, review its teaching quality, and verify that the finished README is complete and consistent.

It helps replace bloated or checklist-style documentation with a clearer explanation of how the project works and why its parts exist. The available details determine what it includes, so it does not fill gaps by inventing features.

readme — Skill for Claude Code and Codex by getkyo: A guided workflow for writing or reviewing a 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.

agentmods

npx agentmods add skills/getkyo/kyo/readme

Any agent

npx skills add getkyo/kyo --skill readme

Clone the repo

git clone --depth 1 https://github.com/getkyo/kyo

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/getkyo/kyo/readme.svg)](https://agentmods.dev/skills/getkyo/kyo/readme)

Your own site

<a href="https://agentmods.dev/skills/getkyo/kyo/readme"><img src="https://agentmods.dev/badge/skills/getkyo/kyo/readme.svg" alt="Measured on agentmods" height="20"></a>

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

When invoked 2,781 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.

Model	Per session	Once invoked
Fable 5	$0.00040	$0.02781
Opus 5	$0.00020	$0.01391
Sonnet 5	$0.00008	$0.00556
Haiku 4.5	$0.00004	$0.00278

Measured 5d ago against content hash 4a0027861651, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

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 5d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (readme-check.sh), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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/SKILL.md · 171 lines

How it starts

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

/readme: supervise a multi-stage README job

This skill is a supervisor. It does not analyze source, draft, diagnose, edit, or verify in this prompt. It dispatches sub-skill agents that do those things, and assembles their outputs into a finished README.

You (the agent reading this prompt) are the top-level agent invoking /readme. You have the Agent tool. The sub-skill agents you dispatch do NOT have the Agent tool, so each sub-skill executes its work inline (no further nesting). Architecture is one level deep, period.

Inputs

$ARGUMENTS is one module path (for example, kyo-http) or two paths (kyo-http kyo-http/README.md) when the README lives in a non-default location. Resolve to:

module_dir: the source directory.
readme_path: the README path (default <module_dir>/README.md).
source_analysis_path: working file at /tmp/readme-source-analysis-<module>.md.
exemplar_path: try fetching the README from main for this module via git show origin/main:<module>/README.md > /tmp/readme-exemplar-<module>.md. Pass this to readme-critique when it exists. When it doesn't (new module, no prior README on main), proceed without an exemplar — the critique runs on pure judgment.

Mode selection

Decide WRITE vs CLEANUP before dispatching anything:

WRITE: no README exists at readme_path, OR the existing README is so far off the spine that a full rewrite is cheaper than action-list cleanup.
CLEANUP: a README exists and its structure is recoverable via a focused action list.

When unsure, default to CLEANUP. The diagnosis sub-skill will report "Out-of-scope findings" if it determines the README needs a full rewrite, at which point you switch to WRITE.

Pipeline

Stage 0: source analysis (both modes)

Dispatch one Opus agent running readme-analyze-source. It produces a single artifact at source_analysis_path: spine candidate ([use-case-first|type-first] tagged), callout candidates, API inventory.

Agent({
  subagent_type: "general-purpose",
  model: "opus",
  description: "Analyze module source",
  prompt: "/readme-analyze-source <module_dir>\n\nWrite output to <source_analysis_path>."
})

Read the full file on GitHub · 171 lines

Files

What ships with it

1 file 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.

readme-check.sh 12 KB runs code

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.

5d ago First seen · 171 lines · 40 tokens per session scan A 4a0027861651

Subscribe to this mod's changes

readme is a skill published in the GitHub repository getkyo/kyo (811 stars, last pushed yesterday), licensed Apache-2.0. It adds 40 tokens to every session and 2,781 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.

Writing and docs

systematic-debugging

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

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 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