agentmods.dev

github-readme

A tool for creating, checking, or updating the README file in a GitHub repository. A README is the main document that explains what a code project does and how to use it.

In plain words
What is it for?
Use it to write a README for a new repository, audit an existing one, or update it after the project’s files, dependencies, or features change.
Why use it?
It helps keep project documentation clear and useful as the code changes. It can also check an existing README for quality, discoverability, and security issues.

Cursor rule

124 +3 3mo ago A scan 59 tokens original MIT
View the source file thatrebeccarae/claude-marketing
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/thatrebeccarae/claude-marketing/github-readme
Clone the repo
git clone --depth 1 https://github.com/thatrebeccarae/claude-marketing
Per session 59 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,829 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.00059 $0.02829
Opus 5 $0.00030 $0.01414
Sonnet 5 $0.00012 $0.00566
Haiku 4.5 $0.00006 $0.00283

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

Security

Grade A, and why

github-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 3d 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.

integrations/cursor/github-readme.mdc · 262 lines

How it starts

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

GitHub README Generator

Generate, audit, or update repository READMEs with project-type detection, voice calibration, discoverability guidance, and scored quality audits.

When to Use

  • Starting a new public repo and need a solid README from scratch
  • Auditing an existing README for quality, discoverability, and security issues
  • Updating a README after the repo has evolved (new deps, features, structure)
  • Preparing a repo for public release and want discoverability optimized

Modes

/github:readme generate [repo-path]   # Scan repo, detect type, generate README
/github:readme audit [repo-path]      # Score existing README (read-only, 0-100)
/github:readme update [repo-path]     # Re-scan, silent audit, patch with approval

Default repo-path is the current working directory if omitted.

Step 0: Parse and Validate

Expect: /github:readme {mode} [repo-path]

  1. Extract mode — generate, audit, or update. Any other value or missing → error with usage hint. STOP.
  2. Extract repo-path — second argument, or current working directory if omitted.
  3. Validate — confirm path exists, is a directory, and contains .git. If not → error. STOP.

Store repo_path (absolute) and mode.

Step 1: Scan the Repo

Gather context by reading available files. Skip gracefully if a file does not exist.

Package/config files (tech stack detection):

  • package.json — Node/TypeScript/React
  • Cargo.toml — Rust
  • pyproject.toml, setup.py, requirements.txt — Python
  • go.mod — Go
  • tsconfig.json — TypeScript confirmation
  • Dockerfile, docker-compose.yml — containerization
  • Makefile, justfile — build system
  • .github/workflows/ — CI/CD

Directory structure:

  • Run ls at repo root for top-level layout
  • Note: src/, bin/, lib/, scripts/, docs/, tests/, skills/, templates/, plugins/, .github/

Existing docs:

  • README.md, CONTRIBUTING.md, SECURITY.md, LICENSE, ARCHITECTURE.md, CHANGELOG.md, CODE_OF_CONDUCT.md, llms.txt

Read the full file on GitHub · 262 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. 3d ago First seen · 262 lines · 59 tokens per session scan A 18670deed99f

Subscribe to this mod's changes

github-readme is a cursor rule published in the GitHub repository thatrebeccarae/claude-marketing (124 stars, last pushed 3mo ago), licensed MIT. It adds 59 tokens to every session and 2,829 once invoked, about $0.0003 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.

Writing and docsai-skillsanthropicclaudeclaude-codedata-visualizationdtc
Related

Other cursor rules, from other repositories

retention-predictor

Skill — retention-predictor. Predicts retention potential via usage frequency, habit formation mechanics, and churn risk factors.

MaxKmet/idea-validation-agents · 24 tokens

svg-check

Apply when editing, generating, or reviewing any SVG diagram. Pixel-perfect Playwright bbox-check is the acceptance test — eyeballing is not sufficient. Run on every SVG before declaring done.

sordi-ai/skill-everything · 37 tokens

angular-20

This rule provides comprehensive best practices and coding standards for Angular development, focusing on modern TypeScript, standalone components, signals, and performance optimizations.

angular/angular · 0 tokens

dev-standard

Apache Superset development standards and guidelines for Cursor IDE.

apache/superset · 1,147 tokens

cli-error-handling

CLI command error handling patterns.

prisma/orm · 0 tokens

prefer-direct-imports-over-module-mocks

Prefer extracting a testable core over vi.mock / vi.resetModules when unit tests need to reach production logic entangled with config, env, or singletons.

prisma/orm · 0 tokens