documentation

A documentation rule requiring every documentation file to contain matching English and Polish sections, with English written first.

In plain words
What is it for?
It is for writing README files, guides, and other documentation with language links, English and Polish sections, separators, and synchronized content.
Why use it?
It keeps documentation available in both languages and makes the two versions follow the same structure.

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

Made for: Cursor.

Per session 529 This file is loaded in full into every session.
When invoked 529 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.00529 $0.00529
Opus 5 $0.00264 $0.00264
Sonnet 5 $0.00106 $0.00106
Haiku 4.5 $0.00053 $0.00053

Measured 2d ago against content hash 345e7c7c47fa, 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.

.cursor/rules/documentation.mdc · 84 lines

How it starts

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

Documentation Standards

Bilingual Documentation (EN/PL)

All documentation files must be bilingual (English/Polish) following this structure:

  1. Primary Language: English - Write all documentation first in English
  2. Secondary Language: Polish - Synchronize Polish version after English is complete
  3. Structure Pattern:
    • Use language anchors: <a name="english"></a> and <a name="polski"></a>
    • English section comes first
    • Polish section comes after, marked with <a name="polski"></a>
    • Use separator: --- between language sections

Documentation File Format

# Document Title

**Language / Język:** [English](#english) | [Polski](#polski)

---

<a name="english"></a>
# English

[English content here]

---

<a name="polski"></a>
# Polski

[Polish content here - synchronized with English]

Writing Guidelines

  1. Write English first - Always create English version first, ensure it's complete and accurate
  2. Synchronize Polish - After English is done, create Polish version that:
    • Maintains the same structure and sections
    • Preserves code examples (they remain in English)
    • Translates all explanatory text accurately
    • Keeps technical terms consistent (use English terms with Polish explanations if needed)
  3. Code Examples - Keep code examples in English, add Polish comments if helpful
  4. Links and References - Maintain English anchor names, translate link text
  5. Consistency - Use consistent terminology across all documents

Files Requiring Bilingual Content

  • README.md
  • All files in docs/ directory
  • USAGE_GUIDE.md
  • QUICKSTART.md
  • Any new documentation files

When Creating New Documentation

  1. Start with English section
  2. Complete English content fully
  3. Add language separator ---
  4. Add Polish anchor and section
  5. Translate content maintaining structure
  6. Verify both versions are synchronized

Code Comments

  • Code comments should be in English (standard practice)
  • Polish comments only when explaining Polish-specific features or context

Read the full file on GitHub · 84 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 · 84 lines · 529 tokens per session scan A 345e7c7c47fa

Subscribe to this mod's changes

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