keep-docs-aligned

A set of project rules for keeping README files and setup instructions consistent with the MCP tools and public APIs in the code. MCP is a standard way for an AI assistant to discover and use tools.

In plain words
What is it for?
Use it when adding, renaming, removing, or changing MCP tools, public APIs, authentication, installation, or Cursor setup. It provides a checklist of the files and details that need updating.
Why use it?
It prevents documentation from listing missing tools, outdated parameters, or behavior that no longer matches the code. It also keeps installation and first-run instructions accurate when setup 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/hackmods/cursor-proxmox-mcp/keep-docs-aligned
Clone the repo
git clone --depth 1 https://github.com/hackmods/cursor-proxmox-mcp

Made for: Cursor.

Per session 341 This file is loaded in full into every session.
When invoked 341 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin fork From a forked repository.
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.00341 $0.00341
Opus 5 $0.00170 $0.00170
Sonnet 5 $0.00068 $0.00068
Haiku 4.5 $0.00034 $0.00034

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

Security

Grade A, and why

keep-docs-aligned 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/keep-docs-aligned.mdc · 29 lines

What it actually says

Keep documentation aligned

When you add, rename, remove, or change behavior of MCP tools, parameters, or public APIs:

  1. Update README.md in the same change — Features, New Features, and Available Tools.
  2. Update src/proxmox_mcp/tools/definitions.py tool descriptions to match the implementation.
  3. Do not document tools that are not registered in src/proxmox_mcp/server.py.
  4. If a tool is planned but not wired yet, mark it clearly as planned — never list it as available.
  5. Keep examples (params, defaults, nesting/features) accurate to the code.
  6. If auth, install, or first-run Cursor wiring changes, update SETUP.md (and proxmox-config/README.md when config fields change).

Checklist before finishing

  • Tool name and params match @self.mcp.tool registration in server.py
  • README inventory / detail sections updated
  • definitions.py description updated
  • SETUP.md still accurate for first-run (if install/auth touched)
  • No stale claims (e.g. endpoint counts, missing tools)

Source of truth

Registered tools live in ProxmoxMCPServer._setup_tools() in server.py. README must match that list. First-run auth/Cursor wiring: SETUP.md.

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 · 29 lines · 341 tokens per session scan A 8480c9130920

Subscribe to this mod's changes

keep-docs-aligned is a cursor rule published in the GitHub repository hackmods/cursor-proxmox-mcp (1 stars, last pushed 15d ago), licensed MIT. It adds 341 tokens to every session, about $0.0017 per session on Opus 5. A static security scan graded it A with 0 findings. It comes from a forked repository.