readme-blueprint-generator

readme-blueprint-generator is a skill for Claude Code from thangchung/agent-engineering-experiment. It costs 76 tokens per session (566 once invoked), scanned A, original, MIT.

A guide for generating a README.md, the main documentation file in a software repository, by examining the project's existing instructions and documentation.

In plain words
What is it for?
Use it to document a repository's purpose, technology stack, architecture, setup steps, development workflow, coding standards, folder structure, and tests.
Why use it?
It gathers project details from scattered files and organizes them into documentation. This makes setup, architecture, tools, coding rules, and testing easier for contributors to understand.

Skill for Claude Code

Written for Claude Code: installed under .claude/.

Good fit Use it to document a repository's purpose, technology stack, architecture, setup steps, development workflow, coding standards, folder structure, and tests.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/thangchung/agent-engineering-experiment/readme-blueprint-generator
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 thangchung/agent-engineering-experiment --skill readme-blueprint-generator
Clone the repo
git clone --depth 1 https://github.com/thangchung/agent-engineering-experiment

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-blueprint-generator

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/thangchung/agent-engineering-experiment/readme-blueprint-generator"><img src="https://agentmods.dev/badge/skills/thangchung/agent-engineering-experiment/readme-blueprint-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 76 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 566 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.00076 $0.00566
Opus 5 $0.00038 $0.00283
Sonnet 5 $0.00015 $0.00113
Haiku 4.5 $0.00008 $0.00057

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

Security

Grade A, and why

readme-blueprint-generator 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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

agentgateway-entraid-obo/.claude/skills/readme-blueprint-generator/SKILL.md · 78 lines

How it starts

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

README Generator Prompt

Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:

  1. Scan all the files in the .github/copilot folder, like:

    • Architecture
    • Code_Exemplars
    • Coding_Standards
    • Project_Folder_Structure
    • Technology_Stack
    • Unit_Tests
    • Workflow_Analysis
  2. Also review the copilot-instructions.md file in the .github folder

  3. Create a README.md with the following sections:

Project Name and Description

  • Extract the project name and primary purpose from the documentation
  • Include a concise description of what the project does

Technology Stack

  • List the primary technologies, languages, and frameworks used
  • Include version information when available
  • Source this information primarily from the Technology_Stack file

Project Architecture

  • Provide a high-level overview of the architecture
  • Consider including a simple diagram if described in the documentation
  • Source from the Architecture file

Getting Started

  • Include installation instructions based on the technology stack
  • Add setup and configuration steps
  • Include any prerequisites

Project Structure

  • Brief overview of the folder organization
  • Source from Project_Folder_Structure file

Key Features

  • List main functionality and features of the project
  • Extract from various documentation files

Development Workflow

  • Summarize the development process
  • Include information about branching strategy if available
  • Source from Workflow_Analysis file

Coding Standards

  • Summarize key coding standards and conventions
  • Source from the Coding_Standards file

Testing

  • Explain testing approach and tools
  • Source from Unit_Tests file

Contributing

  • Guidelines for contributing to the project
  • Reference any code exemplars for guidance
  • Source from Code_Exemplars and copilot-instructions

License

  • Include license information if available

Read the full file on GitHub · 78 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 · 78 lines · 76 tokens per session scan A 69a655f3ed17

Subscribe to this mod's changes

readme-blueprint-generator is a skill published in the GitHub repository thangchung/agent-engineering-experiment (24 stars, last pushed 1mo ago), licensed MIT. It adds 76 tokens to every session and 566 once invoked, about $0.0004 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

phoenix-cli-development

Design and implementation guide for the Phoenix CLI (px). Covers the noun-verb command structure, dual-audience design (humans and coding agents), Commander.js patterns, configuration resolution, output formats, exit codes, and conventions for adding or modifying commands. Triggers when working on phoenix-cli commands…

Arize-ai/phoenix · 105 tokens

annotate-spans

Write effective, consistent annotations on LLM/agent spans and traces, and coach the user on annotation practice. Load this whenever you are about to record structured feedback with the ui.spans.annotate operation (via executebrowseraction), or when the user asks how to annotate, label, score, or review spans/traces…

Arize-ai/phoenix · 120 tokens

playground

Author, edit, or iterate on prompts in the Phoenix prompt playground, including running experiments over a dataset. Load before any playground ui. operation call, including single-shot prompt rewrites.

Arize-ai/phoenix · 42 tokens

phoenix-graphql

Write efficient GraphQL queries against the Phoenix API. Load this skill in two cases: (1) before composing any non-trivial GraphQL query yourself for data analysis (via the phoenix-gql bash command) — it contains schema entrypoints and patterns that eliminate the need for introspection; (2) when the user asks for…

Arize-ai/phoenix · 102 tokens

datasets

Understand what a Phoenix dataset is and reason well about its examples, outputs, splits, and how it feeds evaluators and experiments. Load this whenever a dataset is in view or the user asks what a dataset is, how splits work, what an output "means", or how datasets relate to experiments and evals. This skill governs…

Arize-ai/phoenix · 78 tokens

debug-trace

Diagnose failure modes by systematically investigating traces. Trigger when the user explicitly asks for cross-trace diagnosis: "what's going wrong?", "were there errors?", "debug this", "where is my agent struggling?". Do NOT trigger on: (1) advice questions ("what should I do?"), (2) statistical questions ("what's…

Arize-ai/phoenix · 113 tokens