documentation-maintenance

documentation-maintenance is a cursor rule for Cursor from lukaszzychal/mcp-doc-generator. It costs 904 tokens per session, scanned A, original, MIT.

A code-change rule that reminds the coding agent to review related documentation whenever it changes a project.

In plain words
What is it for?
It is for checking and updating files such as README.md, setup guides, API references, migration notes, changelogs, and CI/CD documentation.
Why use it?
It helps prevent documentation from becoming inaccurate or incomplete after code, configuration, structure, or workflow changes.

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/lukaszzychal/mcp-doc-generator/documentation-maintenance
Clone the repo
git clone --depth 1 https://github.com/lukaszzychal/mcp-doc-generator

Made for: Cursor.

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 documentation-maintenance

README.md
[![agentmods](https://agentmods.dev/badge/rules/lukaszzychal/mcp-doc-generator/documentation-maintenance.svg)](https://agentmods.dev/rules/lukaszzychal/mcp-doc-generator/documentation-maintenance)
Your own site
<a href="https://agentmods.dev/rules/lukaszzychal/mcp-doc-generator/documentation-maintenance"><img src="https://agentmods.dev/badge/rules/lukaszzychal/mcp-doc-generator/documentation-maintenance.svg" alt="Measured on agentmods" height="20"></a>
Per session 904 This file is loaded in full into every session.
When invoked 904 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.00904 $0.00904
Opus 5 $0.00452 $0.00452
Sonnet 5 $0.00181 $0.00181
Haiku 4.5 $0.00090 $0.00090

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

Security

Grade A, and why

documentation-maintenance 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.

.cursor/rules/documentation-maintenance.mdc · 127 lines

How it starts

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

Documentation Maintenance

Always Check Documentation

When making code changes, new features, or modifications, always check if documentation needs to be updated or if new documentation should be added.

When to Update Documentation

1. New Features or Functionality

  • Add new tools or functions → Update README.md and relevant docs
  • New configuration options → Update QUICKSTART.md or USAGE_GUIDE.md
  • New installation methods → Update installation guides

2. Code Changes

  • API changes → Update API documentation
  • Configuration changes → Update configuration guides
  • Breaking changes → Update migration guides or changelog

3. Project Structure Changes

  • New directories → Update PROJECT_STRUCTURE.md
  • New scripts → Document in relevant guides
  • New dependencies → Update requirements.txt and installation docs

4. Workflow Changes

  • New build process → Update build documentation
  • New deployment process → Update deployment guides
  • CI/CD changes → Update CI/CD documentation

Documentation Checklist

Before completing any code changes, verify:

  • README.md - Is the main README up to date?
  • docs/ - Are relevant documentation files updated?
  • Examples - Do examples still work and reflect current state?
  • Quick Start - Can new users still follow quick start guide?
  • API/Schema - Are any API changes documented?
  • Configuration - Are configuration options documented?

New Documentation Needed

Consider creating new documentation when:

  1. New major feature → Create dedicated guide in docs/
  2. Complex workflow → Document step-by-step process
  3. Common issues → Add troubleshooting section
  4. Integration guides → Document new integrations
  5. Architecture changes → Update architecture documentation

Documentation Update Process

  1. Identify affected docs - List all documentation that might need updates
  2. Review current state - Check if existing docs are accurate
  3. Update or create - Modify existing docs or create new ones
  4. Maintain bilingual format - Ensure both English and Polish versions are updated
  5. Verify links - Check that all internal links still work
  6. Test examples - Ensure code examples in docs still work

Read the full file on GitHub · 127 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 · 127 lines · 904 tokens per session scan A 151ed7038b21

Subscribe to this mod's changes

documentation-maintenance is a cursor rule published in the GitHub repository lukaszzychal/mcp-doc-generator (2 stars, last pushed 9mo ago), licensed MIT. It adds 904 tokens to every session, about $0.0045 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.