readme-generate

readme-generate is a skill for Claude Code, Codex from HK-hub/AgentSkills. It costs 20 tokens per session (1,788 once invoked), scanned A, original, MIT.

A tool that creates detailed README.md documentation for Spring Boot modules, including their features, APIs, usage, implementation, and testing guidance.

In plain words
What is it for?
Use it to document new or changed Spring Boot modules and their API interfaces.
Why use it?
It reduces the work of writing and updating consistent documentation for Java backend modules.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: reads .claude/ paths.

Good fit Use it to document new or changed Spring Boot modules and their API interfaces.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/hk-hub/agentskills/readme-generate
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 HK-hub/AgentSkills --skill readme-generate
Clone the repo
git clone --depth 1 https://github.com/HK-hub/AgentSkills

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/hk-hub/agentskills/readme-generate"><img src="https://agentmods.dev/badge/skills/hk-hub/agentskills/readme-generate.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 20 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,788 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. 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.00020 $0.01788
Opus 5 $0.00010 $0.00894
Sonnet 5 $0.00004 $0.00358
Haiku 4.5 $0.00002 $0.00179

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

Security

Grade A, and why

readme-generate scanned grade A with 1 finding 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.

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

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- **HTTP Requests**: Ready-to-use curl commands
readme-generate/SKILL.md · 227 lines

How it starts

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

README Generator

This skill automatically analyzes Spring Boot modules and generates comprehensive README.md files according to the specified format requirements, including module functionality, API documentation, usage examples, technical implementation, testing guidance, and important notes.

When to Use

Use this skill when you need to:

  • Generate README.md files for new modules
  • Update existing README.md files when module content changes
  • Create consistent documentation across multiple modules
  • Document API interfaces automatically
  • Provide comprehensive module documentation for developers

How to Use

Generate README for a Module

Execute the README generator script to create comprehensive documentation:

python .claude/skills/readme-generate/scripts/readme_generator.py <module_path> [output_file]

Parameters:

  • module_path (required): Path to the Spring Boot module directory
  • output_file (optional): Custom output file path (default: {module_path}/README.md)

Examples:

# Generate for chat module-generate.md (creates basic/chat/README.md)
python .claude/skills/readme-generate/scripts/readme_generator.py basic/chat

# Generate for tool module-generate.md with custom output
python .claude/skills/readme-generate/scripts/readme_generator.py basic/tool custom_README.md

# Generate for image module-generate.md
python .claude/skills/readme-generate/scripts/readme_generator.py basic/image

# Update existing README
python .claude/skills/readme-generate/scripts/readme_generator.py graph/parallel

Generated README Structure

The skill generates README.md files that strictly follow the task specification:

1. 模块功能介绍 (Module Functionality Description)

  • Automatically extracts module functionality from controller classes
  • Generates comprehensive descriptions based on actual implementation
  • Provides clear overview of module purpose and capabilities

2. 接口文档 (API Documentation)

  • Complete API Coverage: All REST endpoints documented
  • Path Information: Full endpoint paths with HTTP methods
  • Parameter Details: All request parameters with default values
  • Response Format: JSON response structure
  • Feature Lists: Key capabilities and characteristics

Read the full file on GitHub · 227 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.

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 · 227 lines · 20 tokens per session scan A 77f6c5a8e44a

Subscribe to this mod's changes

readme-generate is a skill published in the GitHub repository HK-hub/AgentSkills (6 stars, last pushed 25d ago), licensed MIT. It adds 20 tokens to every session and 1,788 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.