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.
npx agentmods add rules/holasoymalva/readme-generator-toolkit/create-readme-from-descriptiongit clone --depth 1 https://github.com/holasoymalva/README-Generator-ToolkitWrote 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.
[](https://agentmods.dev/rules/holasoymalva/readme-generator-toolkit/create-readme-from-description)<a href="https://agentmods.dev/rules/holasoymalva/readme-generator-toolkit/create-readme-from-description"><img src="https://agentmods.dev/badge/rules/holasoymalva/readme-generator-toolkit/create-readme-from-description.svg" alt="Measured on agentmods" height="20"></a>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.00008 | $0.00959 |
| Opus 5 | $0.00004 | $0.00479 |
| Sonnet 5 | $0.00002 | $0.00192 |
| Haiku 4.5 | $0.00001 | $0.00096 |
Grade A, and why
create-readme-from-description 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.
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.
How it starts
The opening of the file, as written. The whole thing — 132 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Rule: Generate README from Project Description
Goal
To guide an AI assistant in creating a comprehensive, professional README.md file based on a project description provided by the user. The README should be clear, engaging, and follow modern documentation best practices.
Process
-
Receive Project Description: The user provides a description of their project, including purpose, features, and any specific requirements.
-
Ask Clarifying Questions: Before generating the README, ask targeted questions to gather essential details:
- Project Purpose: "What problem does this project solve? Who is the target audience?"
- Key Features: "What are the 3-5 most important features users should know about?"
- Technology Stack: "What technologies, frameworks, or languages are you using?"
- Installation Requirements: "What dependencies or prerequisites are needed?"
- Usage Scenarios: "Can you provide 1-2 common use cases or examples?"
- Project Status: "Is this in development, beta, or production ready?"
- Contributing: "Do you want to include contribution guidelines? Open source or private?"
- Visual Elements: "Do you have any screenshots, demos, or diagrams to include?"
-
Generate README: Create a comprehensive README using the structure outlined below.
-
Save File: Save as
README.mdin the project root directory.
README Structure
Generate a README with these sections:
1. Header Section
- Project title with relevant emoji
- Brief, compelling description (1-2 sentences)
- Key badges (build status, version, license, etc.)
- Links to demo, documentation, or live version if applicable
2. Table of Contents (for longer READMEs)
- Quick navigation for sections below
3. About / Overview
- What the project does
- Why it exists (problem it solves)
- Key benefits or unique selling points
4. Features
- Bullet points of main functionalities
- Use emojis for visual appeal
- Keep descriptions concise but informative
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 · 132 lines · 8 tokens per session scan A 9e401e65f8b9
create-readme-from-description 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 959 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.
Other cursor rules, from other repositories
propose-test-cases
Propose comprehensive test cases for PR changes.
detect-code-smells
Detect code smells and anti-patterns in PR changes.
suggest-improvements
Provide actionable improvement suggestions for PR changes.
analyze-pr-changes
Comprehensive analysis of Pull Request changes.
composer-coding-excellence
Coding craft — surgical edits, convention matching, no scope creep, no slop comments, no fabricated APIs.
composer-core
Always-on builder spine — continue the app, demoable slice, Build loop, Run/Wired handoff, ask only on high confusion weight.