[IMPORTANT] Use TaskCreate to break ALL work into small tasks BEFORE starting — including tasks for each file read. This prevents context loss from long files. For simple tasks, AI MUST ATTENTION ask user whether to skip.Prerequisites: MUST ATTENTION READ before executing:
Scan & Update Reference Doc — When updating reference docs: (1) Read existing doc first. (2) Scan codebase for current state (grep/glob). (3) Diff findings vs doc content. (4) Update ONLY sections where code diverged from doc. (5) Preserve manual annotations. (6) Update metadata (date, counts). NEVER rewrite entire doc — surgical updates only.
Output Quality — Reference docs are injected into AI context. Apply 10 rules: (1) No inventories/counts — AI can grep. (2) No directory trees — AI can glob. (3) No TOCs. (4) Rules > descriptions — "MUST ATTENTION use X" not "X allows you to...". (5) 1 example per pattern. (6) Tables > prose. (7) BAD/GOOD pairs: 2-3 lines each. (8) Primacy-recency anchoring — critical rules in first AND last 5 lines. (9) No checkbox checklists — bullets force reading. (10) Density target: >=8 MUST ATTENTION/NEVER/ALWAYS per 100 lines.
Quick Summary
Goal: Scan project codebase and populate docs/project-reference/domain-entities-reference.md with domain entities, data models, DTOs, aggregate boundaries, cross-service entity sync maps, and Mermaid ER diagrams. (content auto-injected by hook — check for [Injected:...] header before reading)
Workflow:
- Read — Load current target doc, detect init vs sync mode
- Scan — Discover entities, models, DTOs, relationships via parallel sub-agents
- Report — Write findings to external report file
- Generate — Build/update reference doc from report
- Verify — Validate entity references point to real files
Key Rules:
- Generic — works with any framework (.NET, Node.js, Java, Python, game engines, etc.)
- Detect framework first, then scan for framework-specific entity patterns
- For microservices: unify cross-service entities (identify owner vs consumer services)
- Every entity reference must come from actual project files with file:line references
- Detail level: summary + key properties (IDs, FKs, status fields, relationships) — NOT full property listing
Be skeptical. Apply critical thinking, sequential thinking. Every claim needs traced proof, confidence percentages (Idea should be more than 80%).
Scan Domain Entities
Phase 0: Read & Assess
- Read
docs/project-reference/domain-entities-reference.md - Detect mode: init (placeholder) or sync (populated)
- If sync: extract existing sections and note what's already documented
Phase 1: Plan Scan Strategy
Detect Project Type & Framework
Scan for project type indicators in this priority order:
- Check
docs/project-config.json— Usemodules[]for service paths,project.languagesfor tech stack - Filesystem detection fallback:
| Indicator | Framework | Entity Patterns to Search |
|---|---|---|
.csproj | .NET | Entity, AggregateRoot, ValueObject, IEntity, BaseEntity, project entity base |
package.json + ORM | Node.js | Mongoose Schema, TypeORM @Entity, Prisma model, Sequelize define |
pom.xml / build.gradle | Java/Kotlin | JPA @Entity, Spring Data, Hibernate, @Table |
requirements.txt / pyproject.toml | Python | Django models.Model, SQLAlchemy, Pydantic BaseModel |
*.proto | Protobuf | message definitions (cross-service contracts) |
| Unity project files | Unity | ScriptableObject, MonoBehaviour data classes |
| Unreal project files | Unreal | UObject, USTRUCT, UCLASS data types |
- Generic fallback (any project): scan for
class.*Entity,class.*Model,class.*Dto,interface.*Repository,schema,@table,collection
Detect Architecture Type
- Microservices: Multiple service directories with separate domain layers → enable cross-service entity sync analysis
- Monolith: Single domain layer → skip cross-service analysis
- Modular monolith: Single deployment but bounded contexts → analyze module boundaries
Use docs/project-config.json modules[] to identify service boundaries. If unavailable, detect from directory structure.
Phase 2: Execute Scan (Parallel Sub-Agents)
Launch 3-4 Explore agents in parallel:
Agent 1: Domain Entities & Aggregates
- Grep for entity base class inheritance (framework-specific patterns from Phase 1)
- Find aggregate root classes
- Find value objects
- Find enum types used as entity properties
- For each entity: note key properties (ID, foreign keys, status/state fields, timestamps)
- Note file paths with line numbers
Agent 2: DTOs, ViewModels & Application Layer Models
- Grep for DTO classes (
*Dto,*DTO,*ViewModel,*Response,*Request) - Find command/query objects that carry entity data
- Identify DTO-to-Entity mapping patterns (who owns mapping, method names)
- Note which DTOs map to which entities
Agent 3: Database Schemas & Persistence
- Find database collection/table definitions
- Find migration files that create/alter entity tables
- Find index definitions on entities
- Find seed data files
- Identify database technology per service (MongoDB, SQL Server, PostgreSQL, etc.)
Agent 4: Cross-Service Entity Sync (microservices only)
- Grep for integration event classes (
*IntegrationEvent,*Event,*Message) - Find message bus consumers that sync entity data across services
- Identify shared contracts/DTOs between services
- Map: which entity originates in which service, which services consume it
- Find event handler classes that create/update projected entities
Write all findings to: plans/reports/scan-domain-entities-{YYMMDD}-{HHMM}-report.md
Phase 3: Analyze & Generate
Read the report. Build these sections:
Target Sections
| Section | Content |
|---|---|
| Entity Catalog | Table per service/module: entity name, key properties (IDs, FKs, status), base class, file path |
| Entity Relationships | Mermaid ER diagram per service showing entity relationships (1:N, N:M, 1:1) |
| Cross-Service Entity Map | Table: entity name, owner service, consumer services, sync mechanism (event name), sync direction |
| DTO Mapping | Table: DTO class → Entity class, mapping approach (manual/auto), file path |
| Aggregate Boundaries | Which entities form aggregates, aggregate root identification |
| Naming Conventions | Detected naming patterns (suffixes, prefixes, namespace conventions) |
Entity Catalog Format
For each service/module, produce a table:
### {ServiceName} Entities
| Entity | Key Properties | Base Class | Relationships | File |
| -------- | ----------------------------- | ---------- | ---------------------- | ---------------------- |
| Employee | Id, CompanyId, UserId, Status | EntityBase | 1:N Goals, 1:N Reviews | `path/Employee.cs:L15` |Detail level: Summary + key properties only. Include: IDs, foreign keys, status/state fields, important business fields. Do NOT list every property.
Cross-Service Entity Map Format (microservices)
When the same entity concept appears in multiple services:
| Unified Entity | Owner Service | Consumer Services | Sync Event | Direction |
| -------------- | ------------- | ------------------ | -------------------- | ----------------- |
| Employee | ServiceA | ServiceB, Accounts | EmployeeCreatedEvent | Owner → Consumers |Mermaid ER Diagram Guidelines
- One diagram per service/bounded context (keep diagrams readable)
- One cross-service diagram showing entity sync flows
- Use Mermaid
erDiagramsyntax - Show only key relationships, not every FK
erDiagram
Employee ||--o{ Goal : "has"
Employee ||--o{ Review : "receives"
Goal ||--o{ CheckIn : "tracks"Content Rules
- Show actual entity class declarations (3-5 lines) with
file:linereferences - Include count of entities per service
- Group by service/module, not by entity type
- For microservices: highlight cross-service boundaries clearly
Phase 4: Write & Verify
- Write updated doc with
<!-- Last scanned: YYYY-MM-DD -->at top - Verify: 5+ entity file paths exist (Glob check)
- Verify: class names in catalog match actual class definitions (Grep check)
- Report: sections updated, entities discovered, coverage gaps
Closing Reminders
- IMPORTANT MUST ATTENTION break work into small todo tasks using
TaskCreateBEFORE starting - IMPORTANT MUST ATTENTION search codebase for 3+ similar patterns before creating new code
- IMPORTANT MUST ATTENTION cite
file:lineevidence for every claim (confidence >80% to act) - IMPORTANT MUST ATTENTION add a final review todo task to verify work quality
- IMPORTANT MUST ATTENTION read existing doc first, scan codebase, diff, surgical update only. Never rewrite entire doc.
- IMPORTANT MUST ATTENTION follow output quality rules: no counts/trees/TOCs, rules > descriptions, 1 example per pattern, primacy-recency anchoring.