improve-readme

improve-readme is a cursor rule for coding agents from holasoymalva/README-Generator-Toolkit. It costs 8 tokens per session (1,340 once invoked), scanned A, original, Apache-2.0.

Instructions for improving an existing README.md file, which is a project's main introductory documentation. They cover its content, structure, clarity, formatting, accuracy, and missing sections.

In plain words
What is it for?
Reviewing a README, finding areas to improve, asking focused questions, and expanding the document while preserving its original purpose and structure.
Why use it?
They help identify unclear instructions, outdated information, poor organization, and important documentation that is missing.

Cursor rule

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 rules/holasoymalva/readme-generator-toolkit/improve-readme
Clone the repo
git clone --depth 1 https://github.com/holasoymalva/README-Generator-Toolkit

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 improve-readme

README.md
[![agentmods](https://agentmods.dev/badge/rules/holasoymalva/readme-generator-toolkit/improve-readme.svg)](https://agentmods.dev/rules/holasoymalva/readme-generator-toolkit/improve-readme)
Your own site
<a href="https://agentmods.dev/rules/holasoymalva/readme-generator-toolkit/improve-readme"><img src="https://agentmods.dev/badge/rules/holasoymalva/readme-generator-toolkit/improve-readme.svg" alt="Measured on agentmods" height="20"></a>
Per session 8 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,340 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.

ModelPer sessionOnce invoked
Fable 5 $0.00008 $0.01340
Opus 5 $0.00004 $0.00670
Sonnet 5 $0.00002 $0.00268
Haiku 4.5 $0.00001 $0.00134

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

Security

Grade A, and why

improve-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 4d 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.

mdc/improve-readme.mdc · 159 lines

How it starts

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

Rule: Improve Existing README

Goal

To guide an AI assistant in analyzing and improving an existing README.md file, making it more comprehensive, clear, and professional while maintaining the original intent and structure.

Process

  1. Receive Existing README: The user provides their current README.md file using @ tag (e.g., @README.md).

  2. Analyze Current README: Systematically evaluate the existing documentation for:

    • Content completeness and accuracy
    • Structure and organization
    • Clarity and readability
    • Visual appeal and formatting
    • Missing essential sections
    • Outdated or incorrect information
  3. Identify Improvement Areas: Categorize findings into:

    • Missing Sections: Essential parts not included
    • Unclear Content: Confusing or poorly explained sections
    • Formatting Issues: Poor structure, inconsistent styling
    • Outdated Information: Old versions, broken links, deprecated instructions
    • Enhancement Opportunities: Ways to make it more engaging or useful
  4. Ask Targeted Questions: Based on analysis, ask specific questions:

    • Focus Areas: "Which sections are most important to improve: [list identified issues]?"
    • Audience: "Has your target audience changed since the original README?"
    • Recent Changes: "Have there been updates to the project not reflected in the README?"
    • Specific Goals: "Are there particular aspects you want to emphasize more?"
    • Style Preferences: "Do you prefer a more technical or user-friendly tone?"
  5. Generate Improved README: Create an enhanced version addressing identified issues.

  6. Save File: Update the existing README.md or create README-improved.md for comparison.

Analysis Framework

Content Analysis

  • Completeness: Does it cover all essential aspects of the project?
  • Accuracy: Are instructions current and correct?
  • Clarity: Can a new user follow the documentation successfully?
  • Examples: Are there practical, working examples?
  • Context: Does it explain the "why" not just the "how"?

Read the full file on GitHub · 159 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. 4d ago First seen · 159 lines · 8 tokens per session scan A d75eeaa85191

Subscribe to this mod's changes

improve-readme is a cursor rule published in the GitHub repository holasoymalva/README-Generator-Toolkit (4 stars, last pushed 1y ago), licensed Apache-2.0. It adds 8 tokens to every session and 1,340 once invoked, about $0.0000 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-31.