project-overview

project-overview is a cursor rule for Cursor from divar-ir/ai-doc-gen. It costs 811 tokens per session, scanned A, original, MIT.

Project rules for an AI Documentation Generator, a Python command-line tool that examines codebases and creates documentation and configuration files for AI coding assistants.

In plain words
What is it for?
Use them when analyzing a repository, generating a README, creating AI-assistant rules, running scheduled analysis, or updating the tool’s agents and handlers.
Why use it?
They describe the commands, project layout, agents, prompts, and configuration requirements needed to change the tool safely.

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/divar-ir/ai-doc-gen/project-overview
Clone the repo
git clone --depth 1 https://github.com/divar-ir/ai-doc-gen

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/divar-ir/ai-doc-gen/project-overview.svg)](https://agentmods.dev/rules/divar-ir/ai-doc-gen/project-overview)
Your own site
<a href="https://agentmods.dev/rules/divar-ir/ai-doc-gen/project-overview"><img src="https://agentmods.dev/badge/rules/divar-ir/ai-doc-gen/project-overview.svg" alt="Measured on agentmods" height="20"></a>
Per session 811 This file is loaded in full into every session.
When invoked 811 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.00811 $0.00811
Opus 5 $0.00405 $0.00405
Sonnet 5 $0.00162 $0.00162
Haiku 4.5 $0.00081 $0.00081

Measured 5d ago against content hash d3f703e24cef, 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 5d 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 · 47 lines

How it starts

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

AI Documentation Generator — Project Overview

Multi-agent Python 3.13 CLI tool (ai-doc-gen) that analyzes codebases with concurrent AI agents and generates documentation: .ai/docs/*.md analyses, README.md, and AI assistant config files (CLAUDE.md, AGENTS.md, .cursor/rules/).

Layout

  • src/main.py — CLI entry point; commands: analyze, generate readme, generate ai-rules, cronjob analyze. CLI arguments are generated dynamically from Pydantic config models.
  • src/config.py — module-level constants from env vars; ANALYZER_LLM_* and DOCUMENTER_LLM_* are required at import time, AI_RULES_LLM_* falls back to documenter values.
  • src/handlers/ — one handler per command (analyze.py, readme.py, ai_rules.py, cronjob.py), all implement AbstractHandler.handle() from @src/handlers/base_handler.py.
  • src/agents/ — pydantic-ai agents (analyzer.py, documenter.py, ai_rules_generator.py), Jinja2 prompt templates in prompts/*.yaml, tools in tools/.
  • src/utils/logger.py (singleton Logger, call init() before use), prompt_manager.py, retry_client.py, worker_pool.py, repo.py, dict.py.
  • skills/ + .claude-plugin/ — Claude Code skills mirroring the agents; keep in sync when changing agent prompts.

Core patterns

  • Handler pattern: handler configs multiple-inherit BaseHandlerConfig + agent config, e.g. class AnalyzeHandlerConfig(BaseHandlerConfig, AnalyzerAgentConfig).
  • Concurrency: 5 analysis agents run through WorkerPool (semaphore-bounded; ANALYZER_MAX_WORKERS, 0 = CPU count); AI-rules generators use asyncio.gather(return_exceptions=True).
  • Error isolation: an agent failure is logged and skipped; fail the run only when ALL agents fail (raise ValueError).
  • Configuration precedence: Pydantic defaults < .ai/config.yaml < CLI arguments, merged via merge_dicts().
  • LLM access: OpenAI-compatible only — OpenAIChatModel + OpenAIProvider with configurable base URL, wrapped in a retrying HTTP client. Temperature 0.0 everywhere.

Read the full file on GitHub · 47 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. 5d ago First seen · 47 lines · 811 tokens per session scan A d3f703e24cef

Subscribe to this mod's changes

project-overview is a cursor rule published in the GitHub repository divar-ir/ai-doc-gen (752 stars, last pushed 1mo ago), licensed MIT. It adds 811 tokens to every session, about $0.0041 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.