project-overview

project-overview is a cursor rule for Cursor from ajgreyling/cursor-doctor. It costs 286 tokens per session, scanned A, original, MIT.

Project context for cursor-doctor, a TypeScript command-line tool that checks whether a codebase has useful documentation, rules, and skills, then creates an improvement plan.

In plain words
What is it for?
It is for understanding the project's architecture, running audits, interpreting findings, maintaining required artifacts, and checking that documentation changes are detected.
Why use it?
It gives the agent shared definitions and a repeatable documentation-first workflow instead of leaving project terms and expected files unclear.

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/ajgreyling/cursor-doctor/project-overview
Clone the repo
git clone --depth 1 https://github.com/ajgreyling/cursor-doctor

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for project-overview

README.md
[![agentmods](https://agentmods.dev/badge/rules/ajgreyling/cursor-doctor/project-overview.svg)](https://agentmods.dev/rules/ajgreyling/cursor-doctor/project-overview)
Your own site
<a href="https://agentmods.dev/rules/ajgreyling/cursor-doctor/project-overview"><img src="https://agentmods.dev/badge/rules/ajgreyling/cursor-doctor/project-overview.svg" alt="Measured on agentmods" height="20"></a>
Per session 286 This file is loaded in full into every session.
When invoked 286 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.00286 $0.00286
Opus 5 $0.00143 $0.00143
Sonnet 5 $0.00057 $0.00057
Haiku 4.5 $0.00029 $0.00029

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

Security

Grade A, and why

project-overview 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 3d 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/project-overview.mdc · 40 lines

What it actually says

Project Overview

Project

  • Name: cursor-doctor
  • Purpose: Audit a codebase for documentation/rules/skills maturity and generate a remediation prescription plan.

Tech stack

  • TypeScript + Node.js CLI (type: module)
  • Artifact discovery with fast-glob
  • Frontmatter serialization with yaml
  • Build pipeline via tsc into dist/

Key terminology

  • Concept catalog: Reference list of required project artifacts (README, rules, docs, skills, infra config).
  • Audit result: Matched concepts plus gaps (found, incomplete, missing).
  • Prescription plan: Generated markdown file with YAML frontmatter todos.
  • Artifact sync: Final pass to align changed docs/rules/skills after implementation.

Documentation-first workflow

  1. Run cursor-doctor generate to produce/update the prescription plan.
  2. Use todo prompts to create or improve required artifacts.
  3. Keep README.md, .cursor/rules/, .cursor/skills/, and docs/ aligned.
  4. Re-run doctor and verify that missing/incomplete counts move in the right direction.

Completeness checklist

  • project name and one-line purpose
  • key terminology
  • tech stack
  • alwaysApply: true
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. 3d ago First seen · 40 lines · 286 tokens per session scan A b795f4716623

Subscribe to this mod's changes

project-overview is a cursor rule published in the GitHub repository ajgreyling/cursor-doctor (0 stars, last pushed 29d ago), licensed MIT. It adds 286 tokens to every session, about $0.0014 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.