documentation

A rule requiring project documentation to be updated after every code change. It covers progress records, changelogs, timestamps, and architecture notes affected by changes.

In plain words
What is it for?
Use it while adding features, fixing bugs, refactoring, or changing the database or architecture so the relevant project records are updated immediately.
Why use it?
It prevents the documentation from falling behind the code and records what features, fixes, or refactors were completed.

Cursor rule for Codex

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/kaelsensei/magicaibuilder/documentation
Clone the repo
git clone --depth 1 https://github.com/KaelSensei/MagicAIBuilder

Made for: Codex.

Per session 1,217 This file is loaded in full into every session.
When invoked 1,217 The same file — it is already loaded in full.
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.01217 $0.01217
Opus 5 $0.00609 $0.00609
Sonnet 5 $0.00243 $0.00243
Haiku 4.5 $0.00122 $0.00122

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

Security

Grade A, and why

documentation 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 2d 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.

.agents/rules/documentation.mdc · 115 lines

How it starts

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

Documentation Maintenance Rules

CRITICAL: Update documentation automatically after every code change.

After completing any feature, bug fix, refactor, or significant change, immediately and automatically update the relevant documentation files.

Required Documentation Updates

1. Project Progress Documentation (Always Required)

After any create/change/update/delete operation, update project progress documentation (e.g. PROGRESS.md, CHANGELOG.md, or similar):

  • For new features: Add to the completed features section (e.g. "✅ Completed Steps" or "🚀 V2 – New Features") with [x] checkbox
  • For bug fixes: Note the fix in the relevant section
  • For refactors: Update the description if functionality changed
  • Update "Last updated" timestamp if the file includes one

Examples:

  • [x] **Search Reset Button**: Clear search query and results with a reset button (X) inside the search input
  • [x] **Board Labels in Search**: Show which board (mainboard/sideboard/considering) each card is found in search results

2. Architecture Documentation

If you modify:

  • Database schema → Update architecture documentation (e.g. magic_the_offlining_architecture.md schema section)
  • External data sources → Update architecture doc (data import / scraping section)
  • Data flow → Update architecture doc (data flow section)
  • UI components → Update architecture doc (UI section) if structure changed significantly

3. Development Plan Documentation

If the project maintains a step-by-step development plan (e.g. magic_the_offlining_step_by_step_dev_plan.md):

  • Mark completed steps as done
  • Update any notes or implementation details

4. README.md

Update README.md if:

  • New features change how the application works
  • Build/install instructions change
  • New dependencies are added
  • Usage instructions need updating

5. Deployment Documentation

If deployment documentation exists (e.g. PLAY_STORE_DEPLOYMENT.md, DEPLOYMENT.md, RELEASE.md):

  • Update when build process changes
  • Update when signing/configuration changes
  • Update when new deployment steps are needed

Read the full file on GitHub · 115 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. 2d ago First seen · 115 lines · 1,217 tokens per session scan A d22c87a22673

Subscribe to this mod's changes

documentation is a cursor rule published in the GitHub repository KaelSensei/MagicAIBuilder (2 stars, last pushed 2d ago), licensed MIT. It adds 1,217 tokens to every session, about $0.0061 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.