auto-update-readme

A repository rule that keeps README.md's rules table current when rule files change. README.md is the main introduction file commonly shown on a code repository's front page.

In plain words
What is it for?
Use it when maintaining a repository's rule files so the README lists their names, descriptions, and smaller variants.
Why use it?
It prevents the documentation from becoming out of date when rules are added, edited, or removed.

Cursor rule for Cursor

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/gurbaaz27/cursorrules/auto-update-readme
Clone the repo
git clone --depth 1 https://github.com/gurbaaz27/cursorrules

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 369 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.00000 $0.00369
Opus 5 $0.00000 $0.00185
Sonnet 5 $0.00000 $0.00074
Haiku 4.5 $0.00000 $0.00037

Measured yesterday against content hash 50a62f53b94c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

auto-update-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 yesterday.

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.

.cursor/rules/auto-update-readme.mdc · 58 lines

What it actually says

Auto-Update README.md

When a rule file in the rules/ directory is created, edited, or deleted, you MUST update README.md to reflect the changes.

Update Process

1. Scan Rules Directory

For each .mdc file in rules/:

  • Extract the rule name from filename (without extension)
  • Read the description field from the frontmatter
  • Skip .mini.mdc files in the main table (list them as sub-items or variants)

2. Update the Rules Table

Update the ## Rules section in README.md with the current rules:

## Rules

| Rule | Description |
| ---- | ----------- |
| [rule-name](rules/rule-name.mdc) | Description from frontmatter |

3. Grouping

If a rule has a .mini.mdc variant:

  • List the main rule in the table
  • Add the mini version as a secondary link or note

Example:

| [auto-update-llms-robots-txt](rules/auto-update-llms-robots-txt.mdc) | Auto-update llms.txt and robots.txt ([mini](rules/auto-update-llms-robots-txt.mini.mdc)) |

4. Preserve Structure

  • Keep the existing README structure intact
  • Only modify the Rules table section
  • Preserve any custom content above/below the table

Output

After updating, briefly confirm:

✅ Updated README.md
- Added: new-rule
- Rules count: X
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. yesterday First seen · 58 lines · 0 tokens per session scan A 50a62f53b94c

Subscribe to this mod's changes

auto-update-readme is a cursor rule published in the GitHub repository gurbaaz27/cursorrules (1 stars, last pushed 8mo ago), licensed CC0-1.0. It costs nothing until one of its globs matches a file; then it loads 369 tokens. 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.