tech-documentation

A set of rules for keeping technical documentation consistent with a project's DEV.md developer guide. It directs the agent to use that guide for architecture, examples, setup, and workflows.

In plain words
What is it for?
Writing or editing documentation that explains architecture, code examples, setup steps, development workflows, and testing procedures.
Why use it?
It prevents documentation from describing the system with different names, commands, or procedures than the project's main developer guide.

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/ekakit/lightfast-mcp/tech-documentation
Clone the repo
git clone --depth 1 https://github.com/ekakit/lightfast-mcp

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 888 The whole file, excluding the scripts and references it only reads on demand.
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.00000 $0.00888
Opus 5 $0.00000 $0.00444
Sonnet 5 $0.00000 $0.00178
Haiku 4.5 $0.00000 $0.00089

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

Security

Grade A, and why

tech-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/tech-documentation.mdc · 140 lines

How it starts

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

Technical Documentation Guidelines

When creating or editing technical documentation, always reference the comprehensive developer guide:

@DEV.md

Documentation Consistency Rules

1. Architecture References

  • Always reference DEV.md for architectural explanations
  • Use consistent terminology from DEV.md (BaseServer, ServerConfig, etc.)
  • Link to DEV.md sections rather than duplicating content

2. Code Examples

  • Use patterns from DEV.md for code examples
  • Reference actual implementation files mentioned in DEV.md
  • Maintain consistency with DEV.md command examples

3. Setup Instructions

  • Point to DEV.md Quick Start for setup procedures
  • Use same command patterns as shown in DEV.md
  • Reference DEV.md prerequisites section

4. Development Workflows

  • Reference DEV.md workflows for development processes
  • Use consistent task commands from DEV.md
  • Point to DEV.md testing strategies

Documentation Validation Checklist

When editing technical documentation:

  • Referenced @DEV.md for comprehensive information
  • Used consistent terminology from DEV.md
  • Commands match those in DEV.md
  • Architecture descriptions align with DEV.md
  • Examples follow DEV.md patterns
  • No duplication of DEV.md content (link instead)

Quick Reference Commands

Always use these commands from DEV.md:

# Setup (from DEV.md Quick Start)
uv pip install -e ".[dev]"
uv run lightfast-mcp-orchestrator init
uv run lightfast-mcp-orchestrator start

# Development (from DEV.md Development Tasks)
uv run task lint
uv run task format
nox -s test_fast

# Testing (from DEV.md Testing section)
nox
uv run pytest tests/unit/ -v

Documentation Types

README Files

  • Keep concise - link to DEV.md for details
  • Use DEV.md Quick Start section for setup
  • Reference DEV.md Architecture for technical details

API Documentation

  • Follow DEV.md patterns for server implementation
  • Use DEV.md examples as templates
  • Reference DEV.md configurations

Read the full file on GitHub · 140 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. yesterday First seen · 140 lines · 0 tokens per session scan A 1bec921db9f9

Subscribe to this mod's changes

tech-documentation is a cursor rule published in the GitHub repository ekakit/lightfast-mcp (2 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 888 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.