learn-agent-skills: Skill for Claude Code

.agents/skills/readme-wizard/SKILL.md

readme-wizard is a skill for Claude Code, Codex from debs-obrien/learn-agent-skills. It costs 177 tokens per session (944 once invoked), scanned A, original, MIT.

A skill for creating or improving a project's README.md, the main guide shown in a code repository. It scans the project and uses the available files and repository data to shape the document.

In plain words
What is it for?
Use it to write or improve README files, including project overviews, setup instructions, badges, documentation tables, and selected repository links.
Why use it?
It avoids made-up project details and helps ensure that sections, badges, links, and instructions reflect what the repository actually contains.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: installed under .agents/ (shared by several agents).

This is debs-obrien/learn-agent-skills's own configuration. It tells Claude Code and Codex how to work on learn-agent-skills itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything learn-agent-skills configures →

Reuse

Borrowing it

Nothing to install: this file belongs to debs-obrien/learn-agent-skills. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/debs-obrien/learn-agent-skills/main/.agents/skills/readme-wizard/SKILL.md
Clone the repo
git clone --depth 1 https://github.com/debs-obrien/learn-agent-skills

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/debs-obrien/learn-agent-skills/readme-wizard"><img src="https://agentmods.dev/badge/skills/debs-obrien/learn-agent-skills/readme-wizard.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 177 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 944 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.00177 $0.00944
Opus 5 $0.00088 $0.00472
Sonnet 5 $0.00035 $0.00189
Haiku 4.5 $0.00018 $0.00094

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

Security

Grade A, and why

readme-wizard 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 10d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/scan_project.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.

.agents/skills/readme-wizard/SKILL.md · 62 lines

How it starts

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

README Wizard

Generate or improve a project's README by scanning the repo and producing a polished, professional result based on real project data.

Workflow

1. Scan the project

Run scripts/scan_project.sh <project-directory> to collect structured JSON metadata:

  • Project name and description
  • License type
  • Git remote (owner and repo name)
  • Package manager (npm, yarn, pnpm, pip, cargo, go, etc.)
  • CI setup (provider and workflow files)
  • Social links (YouTube, Discord, Twitter, LinkedIn, Bluesky, Twitch)
  • Directory structure (top 2 levels)

The reference script checks local files first, then uses the GitHub API to look up the homepage URL and crawls that homepage for additional social links. Your own first version can stay local-file only and add this enrichment later if you want it.

Handling missing data: The scan will return empty strings for anything it can't find. Never fabricate metadata — if a field is empty, skip the related section or badge entirely. For example: no CI workflows means no build badge; no social links means no social section.

2. Read the best practices guide

Read references/readme-best-practices.md before writing. It covers structure, tone, project-type adaptation, and common pitfalls. This context makes a real difference in output quality — the guide explains the reasoning behind each section so you produce READMEs that feel intentional rather than formulaic.

3. Build the README

Use assets/readme-template.md as the base structure. Replace {{PLACEHOLDER}} markers with actual project data from the scan.

When rendering the project tree, keep it close to how people browse repos: list directories before files, alphabetize within each group, and add trailing / markers for directories.

Adapt — don't copy blindly. The template is a starting point. Drop sections that don't apply (e.g., no Contributing section for a personal notes repo) and adjust the tone to match the project:

  • Libraries/frameworks: Focus on installation, API, and examples
  • Applications: Focus on setup, configuration, and screenshots
  • Docs/learning repos: Focus on structure and navigation
  • Small utilities/scripts: Keep it short — hero + what it does + usage is enough

Read the full file on GitHub · 62 lines

Files

What ships with it

6 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. 10d ago First seen · 62 lines · 177 tokens per session scan A cdca27fe7851

Subscribe to this mod's changes

readme-wizard is a skill published in the GitHub repository debs-obrien/learn-agent-skills (49 stars, last pushed 5mo ago), licensed MIT. It adds 177 tokens to every session and 944 once invoked, about $0.0009 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