What is keep-readme-updated?

A maintenance rule for keeping README.md and AGENTS.md tool lists aligned with the MCP server’s Python code. MCP tools are functions that an AI assistant can call.

Use it after changing tool functions in server.py, including updating descriptions, grouping, and the workflow diagram when needed.

It prevents the documentation from becoming inaccurate when tools are added, removed, or renamed.

keep-readme-updated — Cursor rule for Cursor by runwhen-contrib

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.

Clone the repo

git clone --depth 1 https://github.com/runwhen-contrib/runwhen-platform-mcp

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.

README.md

[![agentmods](https://agentmods.dev/badge/rules/runwhen-contrib/runwhen-platform-mcp/keep-readme-updated/github.svg)](https://agentmods.dev/rules/runwhen-contrib/runwhen-platform-mcp/keep-readme-updated)

Your own site

<a href="https://agentmods.dev/rules/runwhen-contrib/runwhen-platform-mcp/keep-readme-updated"><img src="https://agentmods.dev/badge/rules/runwhen-contrib/runwhen-platform-mcp/keep-readme-updated/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/rules/runwhen-contrib/runwhen-platform-mcp/keep-readme-updated"><img src="https://agentmods.dev/badge/rules/runwhen-contrib/runwhen-platform-mcp/keep-readme-updated.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 0 Nothing until a file matches its globs; then the whole rule loads.

When invoked 221 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00000	$0.00221
Opus 5.5	$0.00000	$0.00088
Sonnet 5.5	$0.00000	$0.00044
Haiku 4.5	$0.00000	$0.00022

Measured 2mo ago against content hash ac631a347c47, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

keep-readme-updated 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 2mo 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.

rules/keep-readme-updated.mdc · 19 lines

What it actually says

keep-readme-updated:

When adding, removing, or renaming an @mcp.tool() function in mcp-server/server.py, update both tool tables:
1. The "Available MCP Tools" section in the root README.md
2. The "MCP Tools" section in AGENTS.md
Each tool should have one row with its function name and a short description derived from the first line of its docstring.
Tools are grouped into "Workspace Intelligence" (read-only queries) and "Task Authoring / Tool Builder" (script lifecycle).
If a new tool doesn't fit either group, add a new section in both files.
Keep the "How It Works" workflow diagram in README.md current if the workflow changes.

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.

2mo ago First seen · 19 lines · 0 tokens per session scan A ac631a347c47

Subscribe to this mod's changes

keep-readme-updated is a cursor rule published in the GitHub repository runwhen-contrib/runwhen-platform-mcp (1 stars, last pushed 6d ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 221 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.

ai-agents mcp-server sre

keep-readme-updated next to 6 cursor rules from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
keep-readme-updatedrunwhen-contrib/runwhen-platform-mcp	Cursor rule	1	6d ago	Apache-2.0	A	0	Cursor
about-codebaselineai-intelligence/lineai-mcp-server	Cursor rule	37	12d ago	MPL-2.0	A	13	Cursor
toc-readmekontent-ai/mcp-server	Cursor rule	10	3d ago	MIT	A	0	Cursor
php-client-implementationdalehurley/php-mcp-sdk	Cursor rule	27	11mo ago	MIT	A	8	Cursor
cursor_rulesgiantswarm/mcp-prometheus	Cursor rule	11	today	Apache-2.0	A	374	Cursor
validate-design-earlyRethunk-AI/clodbridge	Cursor rule	0	4mo ago	MIT	A	227	Cursor
ponytailDietrichGebert/ponytail	Cursor rule	186k	9d ago	MIT	A	604	Cursor