documentation

A set of rules for writing software documentation, including READMEs, API references, code comments, and Markdown.

In plain words
What is it for?
Use it when creating or reviewing project documentation, JSDoc, comments, API descriptions, changelogs, and migration guides.
Why use it?
It gives contributors consistent guidance for explaining installation, usage, functions, errors, changes, and interfaces.

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/arjshiv/localutils-mcp-server/documentation
Clone the repo
git clone --depth 1 https://github.com/arjshiv/localutils-mcp-server

Made for: Cursor.

Per session 247 This file is loaded in full into every session.
When invoked 247 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.00247 $0.00247
Opus 5 $0.00123 $0.00123
Sonnet 5 $0.00049 $0.00049
Haiku 4.5 $0.00025 $0.00025

Measured yesterday against content hash e93f3a9f52dc, 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 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/documentation.mdc · 51 lines

What it actually says

Documentation Standards

README.md

  • Clear project description
  • Installation instructions
  • Usage examples
  • API documentation
  • Contributing guidelines
  • License information

JSDoc Comments

  • Document all public functions and classes
  • Include parameter descriptions
  • Specify return types
  • Document thrown errors
  • Add examples for complex functions

Code Comments

  • Write self-documenting code
  • Comment only when necessary
  • Explain why, not what
  • Keep comments up to date
  • Use TODO comments for future work

Markdown Style

  • Use proper heading hierarchy
  • Include table of contents for long documents
  • Use code blocks with language specification
  • Include links to related documentation
  • Keep line length under 100 characters

API Documentation

  • Document all endpoints
  • Include request/response examples
  • List all parameters
  • Document error responses
  • Provide authentication details

Change Documentation

  • Keep CHANGELOG.md up to date
  • Follow semantic versioning
  • Document breaking changes
  • Include migration guides
  • Reference issue numbers

Type Documentation

  • Document complex types
  • Include usage examples
  • Document type constraints
  • Link to related interfaces
  • Document generic parameters
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 · 51 lines · 247 tokens per session scan A e93f3a9f52dc

Subscribe to this mod's changes

documentation is a cursor rule published in the GitHub repository arjshiv/localutils-mcp-server (2 stars, last pushed 8mo ago), licensed MIT. It adds 247 tokens to every session, about $0.0012 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.