package-documentation

A set of rules for structuring README.md files, which are the main documentation files in many software packages.

In plain words
What is it for?
Use it when writing or reviewing package README files in the MCP DevTools repository.
Why use it?
It gives package documentation a consistent layout so developers can find setup instructions, tool details, examples, and configuration information.

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/dxheroes/mcp-devtools/package-documentation
Clone the repo
git clone --depth 1 https://github.com/DXHeroes/mcp-devtools

Made for: Cursor.

Per session 346 This file is loaded in full into every session.
When invoked 346 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.00346 $0.00346
Opus 5 $0.00173 $0.00173
Sonnet 5 $0.00069 $0.00069
Haiku 4.5 $0.00035 $0.00035

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

Security

Grade A, and why

package-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/package-documentation.mdc · 63 lines

What it actually says

Package Documentation Standards

Each package README.md should follow this structure:

@file packages/jira/README.md @file .cursor/rules/repository-structure.mdc

Required Sections

  1. Title and Badges

    # @mcp-devtools/package-name
    
    ![npm version](mdc:https:/img.shields.io/npm/v/@mcp-devtools/package-name.svg)
    ![License: MIT](mdc:https:/img.shields.io/badge/License-MIT-blue.svg)
    ![Status Badge](mdc:https:/img.shields.io/badge/status-beta-orange)
    
  2. Short Description

    • Single paragraph explaining the purpose of the package
  3. Highlights

    • Bullet points of key features with emoji icons
  4. Quick Start

    • Installation instructions
    • Configuration examples
    • Minimal setup code
  5. Tool Reference

    • Table with columns: Tool, Description, Parameters, Aliases, Implementation
    • Each parameter should list type and whether it's required
    • Link each tool name to its implementation file
  6. Usage Examples

    • Show practical examples of using each tool
    • Group related examples under headings
  7. Configuration

    • Environment variables
    • Configuration options
    • Integration examples with different platforms

Style Guidelines

  • Use emoji icons in section headers
  • Include code examples in markdown code blocks
  • Use tables for structured information
  • Keep language clear and concise
  • Include links to related documentation
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 · 63 lines · 346 tokens per session scan A f1fc1a285d54

Subscribe to this mod's changes

package-documentation is a cursor rule published in the GitHub repository DXHeroes/mcp-devtools (13 stars, last pushed 1y ago), licensed MIT. It adds 346 tokens to every session, about $0.0017 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-30.

Related

Other cursor rules, from other repositories

cursorrules

You are building an AI/ML project with Python. The project uses PyTorch for model training, handles data pipelines with proper validation, tracks experiments systematically, and follows production ML engineering practices. Code is type-hinted, tested, and reproducible.

survivorforge/cursor-rules · 2,136 tokens

rule

AI/ML Python development (PyTorch, scikit-learn).

survivorforge/cursor-rules · 0 tokens

language-agnostic-patterns

Language-agnostic programming patterns: SOLID, design patterns, clean code, and architecture. Load when refactoring, designing abstractions, or reviewing structure — not for everyday syntax.

madebyaris/advance-minimax-m3-cursor-rules · 37 tokens

cursor-tools-mastery

Cursor 3.7 runtime guide: choose the right tool, canvases, Design Mode, /worktree, /best-of-n, Await, and parallel execution where safe.

madebyaris/advance-minimax-m3-cursor-rules · 36 tokens

cursor-agent-orchestration

Cursor 3.7 orchestration guide: when to plan, when to delegate, nested subagents, multi-environment handoffs, /best-of-n, and Await for long-running branches.

madebyaris/advance-minimax-m3-cursor-rules · 39 tokens

fable5-reasoning

Fable 5 reasoning protocols: task interpretation, risk-first decomposition, approach selection, interleaved thinking, hypothesis ledgers, premortems, calibration, and the stuck-strategy ladder. Load for complex, ambiguous, or long-horizon tasks, for debugging strategy, or whenever progress stalls.

madebyaris/advance-minimax-m3-cursor-rules · 60 tokens