IMPORTANT

A project rule requiring a documented process whenever files in the docs/ directory are changed. The process includes reviewing project guidance and checking referenced sources.

In plain words
What is it for?
Use it as a checklist for updating documentation files, including reading relevant plans, extracting references, and rechecking cited repositories or web pages.
Why use it?
It prevents documentation changes from being made without the project's required research and review steps. This matters especially when documents contain links or external references.

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/starch-uk/agent-docs/important
Clone the repo
git clone --depth 1 https://github.com/starch-uk/agent-docs

Made for: Cursor.

Per session 1,398 This file is loaded in full into every session.
When invoked 1,398 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.01398 $0.01398
Opus 5 $0.00699 $0.00699
Sonnet 5 $0.00280 $0.00280
Haiku 4.5 $0.00140 $0.00140

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

Security

Grade A, and why

IMPORTANT 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/IMPORTANT.mdc · 98 lines

How it starts

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

Important Project Guidelines

Documentation Files

  • Use docs/*.md files: Refer to and use the documentation files in the docs/ directory for project-specific information and guidelines.

  • Use .cursor/plans/*.md files: Refer to and use planning documents in the .cursor/plans/ directory for project planning and development guidance.

Updating Existing Documentation - CRITICAL REQUIREMENT

MANDATORY: When updating any file in the docs/ directory, you MUST follow the documented process. This is NON-NEGOTIABLE.

What you MUST do:

  1. Understand the workflow first - Before making any changes to a doc file, understand the complete workflow
  2. Extract references - Extract repository URLs, web page URLs, or Salesforce article references from the doc file itself
  3. Re-research sources - Extract repository URLs, web page URLs, or other references from the doc file itself. CRITICAL: If a repository URL is already present in the existing docs/*.md file, extract the repository URL directly from the doc file and proceed to cloning.
  4. Clone repository - Clone repo using full permissions to system's temporary folder (if applicable)
  5. Systematic review - Go through every URL on the official page and every file in the repo (verify ALL files inspected)
  6. Verify all content - All content in markdown file must be verified or removed/changed
  7. Add missing content - Anything missing should be added
  8. Cleanup - Delete temporary repository directory after inspection
  9. Verify ALL todos completed - Before proceeding, verify ALL file inspection todos are completed (count must match file count exactly)
  10. Optimize - Actually execute the OPTIMISE.md plan after updates (ONLY after ALL todos completed, read it, apply techniques, don't just mark as done)
  11. Version - Follow VERSIONING.md to determine and update version numbers

What you MUST NOT do:

  • ❌ Update doc files without understanding the workflow first
  • ❌ Make changes without re-researching sources
  • ❌ Skip repository cloning for repository-based docs
  • ❌ Skip the verification process
  • ❌ Skip file inspection (ALL files must be inspected)
  • ❌ Leave temporary directories on the system
  • ❌ Mark optimization as "done" without actually executing it
  • ❌ Skip optimization or versioning steps
  • ❌ Begin optimization before ALL file inspection todos are completed
  • ❌ Cancel or skip remaining todos because "essential review is complete"

Read the full file on GitHub · 98 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 · 98 lines · 1,398 tokens per session scan A 18a5c9e620db

Subscribe to this mod's changes

IMPORTANT is a cursor rule published in the GitHub repository starch-uk/agent-docs (6 stars, last pushed 5mo ago), licensed MIT. It adds 1,398 tokens to every session, about $0.0070 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.