SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsscan-domain-entities

scan-domain-entities

Data & analytics

View repository

Updated 10-15 21:35

About this skill

Codex compatibility note:

  • Invoke repository skills with $skill-name in Codex; this mirrored copy rewrites legacy Claude /skill-name references.
  • Task tracker mandate: BEFORE executing any workflow or skill step, create/update task tracking for all steps and keep it synchronized as progress changes.
  • User-question prompts mean to ask the user directly in Codex.
  • Ignore Claude-specific mode-switch instructions when they appear.
  • Strict execution contract: when a user explicitly invokes a skill, execute that skill protocol as written.
  • Subagent authorization: when a skill is user-invoked or AI-detected and its protocol requires subagents, that skill activation authorizes use of the required spawn_agent subagent(s) for that task.
  • Do not skip, reorder, or merge protocol steps unless the user explicitly approves the deviation first.
  • For workflow skills, execute each listed child-skill step explicitly and report step-by-step evidence.
  • If a required step/tool cannot run in this environment, stop and ask the user before adapting.

Codex Project-Reference Loading (No Hooks)

Codex does not receive Claude hook-based doc injection. When coding, planning, debugging, testing, or reviewing, open project docs explicitly using this routing.

Always read:

  • docs/project-config.json (project-specific paths, commands, modules, and workflow/test settings)
  • docs/project-reference/docs-index-reference.md (routes to the full docs/project-reference/* catalog)
  • docs/project-reference/lessons.md (always-on guardrails and anti-patterns)

Situation-based docs:

  • Backend/CQRS/API/domain/entity changes: backend-patterns-reference.md, domain-entities-reference.md, project-structure-reference.md
  • Frontend/UI/styling/design-system: frontend-patterns-reference.md, scss-styling-guide.md, design-system/README.md
  • Spec/test-case planning or TC mapping: feature-docs-reference.md
  • Integration test implementation/review: integration-test-reference.md
  • E2E test implementation/review: e2e-test-reference.md
  • Code review/audit work: code-review-rules.md plus domain docs above based on changed files

Do not read all docs blindly. Start from docs-index-reference.md, then open only relevant files for the task.

Quick Summary

Goal: Scan project codebase → 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. (read directly when relevant; do not rely on hook-injected conversation text)

Workflow:

  1. Classify — Detect architecture type and framework before scanning
  2. Scan — Parallel sub-agents discover entities, DTOs, relationships, cross-service sync
  3. Report — Write findings incrementally to report file
  4. Generate — Build/update reference doc from report
  5. Fresh-Eyes — Round 2 verification + coverage report

Key Rules:

  • Generic — works with any framework (.NET, Node.js, Java, Python, game engines) MUST ATTENTION detect BOTH framework AND architecture type before sub-agents launch
  • For microservices: unify cross-service entities (owner vs consumer)
  • Detail level: summary + key properties (IDs, FKs, status fields) — NOT full property listing
Scan Domain Entities

Phase 0: Classify Architecture & Framework

Before any other step, run in parallel:

  1. Read docs/project-reference/domain-entities-reference.md

    • Detect mode: Init (placeholder) or Sync (populated)
    • In Sync mode: extract entity catalog sections → skip re-scanning up-to-date services

  2. Detect framework from project files:

Indicator Framework Entity Patterns to Search
.csproj .NET Entity, AggregateRoot, ValueObject, IEntity, BaseEntity
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)
  1. Detect architecture type:
Signal Architecture Sub-Agents
Multiple service directories with separate domain layers Microservices Run all 4 agents including Agent 4 (cross-service)
Single domain layer Monolith Run Agents 1-3, skip Agent 4
Single deployment, bounded contexts Modular monolith Run Agents 1-3, analyze module boundaries
  1. Load service paths from docs/project-config.json modules[] if available.

Evidence gate: Confidence <60% on framework detection → report uncertainty, DO NOT proceed with framework-specific scan.

Phase 1: Plan

Create task tracking entries for each sub-agent, each service/module to scan, and the coverage report step. Do not start Phase 2 without tasks created.

Phase 2: Execute Scan (Parallel Sub-Agents)

Launch 3-4 general-purpose sub-agents in parallel. Each MUST:

  • Write findings incrementally after each service/file — NEVER batch at end
  • Cite file:line for every entity example
  • Confidence: >80% document; 60-80% note as "observed (unverified)"; <60% omit

All findings → plans/reports/scan-domain-entities-{YYMMDD}-{HHMM}-report.md

Agent 1: Domain Entities & Aggregates

Think: What is the entity hierarchy in this project? Which classes are aggregate roots vs leaf entities vs value objects? What are the key business properties (IDs, status, foreign keys)? Where is domain logic placed?

  • Grep for entity base class inheritance (framework-specific from Phase 0)
  • Find aggregate root classes
  • Find value objects
  • Find enum types used as entity properties
  • For each entity: note key properties (ID, FKs, status/state fields, timestamps)
  • Record file paths with line numbers

Agent 2: DTOs, ViewModels & Application Layer Models

Think: How does data flow from entities to consumers? Who owns the mapping — the DTO, the handler, or a mapper service? Where is the mapping defined?

  • 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

Think: How are entities persisted? What indexes exist? What databases are used per service? Where is schema evolution handled?

  • Find database collection/table definitions
  • Find migration files that create/alter entity tables
  • Find index definitions on entities
  • Identify database technology per service (MongoDB, SQL Server, PostgreSQL)
  • Find seed data files

Agent 4: Cross-Service Entity Sync (microservices only — skip otherwise)

Think: Which entities cross service boundaries? Who owns them? How are they synced — via events, via direct API calls, or via shared database (the last being an anti-pattern)?

  • 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

Phase 3: Analyze & Generate

Read full report. Apply fresh-eyes protocol:

Round 1 (main agent): Build section drafts from report findings.

Round 2 (fresh sub-agent, zero memory):

  • Does every entity in the catalog have a real file:line reference? (Glob verify)
  • Do class names in examples match actual class definitions? (Grep verify)
  • Coverage gap report: which services have NO entities found?
  • Are cross-service sync entries accurate (right owner, right consumer)?

Target Sections

Section Content
Entity Catalog Table per service/module: entity name, key properties (IDs, FKs, status), base class, file:line
Entity Relationships Mermaid ER diagram per service — key relationships only
Cross-Service Entity Map Table: entity, owner service, consumer services, sync event, direction
DTO Mapping Table: DTO class → Entity class, mapping approach, file:line
Aggregate Boundaries Which entities form aggregates, aggregate root identification
Naming Conventions Detected naming patterns (suffixes, prefixes, namespace conventions)
Coverage Report Services scanned / entities found / services with NO entities (gaps)

Entity Catalog Format

### {ServiceName} Entities

| Entity   | Key Properties                | Base Class | Relationships | File                   |
| -------- | ----------------------------- | ---------- | ------------- | ---------------------- |
| Employee | Id, CompanyId, UserId, Status | EntityBase | 1:N Goals     | `path/Employee.cs:L15` |

Detail level: Summary + key properties only — IDs, FKs, status/state, important business fields. Do NOT list every property.

Mermaid ER Diagram Guidelines

  • One diagram per service/bounded context (keep readable)
  • One cross-service diagram showing entity sync flows
  • Show only key relationships, not every FK

Phase 4: Write & Verify

  1. Write updated doc with <!-- Last scanned: YYYY-MM-DD --> at top
  2. Surgical update only — preserve unchanged sections
  3. Verify (Glob check): ALL entity file paths exist — not just 5
  4. Verify (Grep check): class names in catalog match actual class definitions
  5. Coverage report: list services with no entities found (flag as gap)
  6. Report: sections updated / unchanged / coverage gaps / violations

[IMPORTANT] Use task tracking to break ALL work into small tasks BEFORE starting — including tasks per file read. Prevents context loss from long files. Simple tasks: ask user whether to skip.

Prerequisites: MUST ATTENTION READ before executing:

Critical Thinking Mindset — Every claim needs traced proof, confidence >80% to act. Anti-hallucination: Never present guess as fact — cite sources, admit uncertainty, self-check output, cross-reference independently. Certainty without evidence = root of all hallucination.

Scan & Update Reference Doc — Surgical updates only, NEVER full rewrite.

  1. Read existing doc first — understand structure and manual annotations
  2. Detect mode: Placeholder (headings only) → Init. Has content → Sync.
  3. Scan codebase (grep/glob) for current patterns
  4. Diff findings vs doc — identify stale sections only
  5. Update ONLY diverged sections. Preserve manual annotations.
  6. Update metadata (date, version) in frontmatter/header
  7. NEVER rewrite entire doc. NEVER remove sections without evidence obsolete.

Output Quality — Token efficiency without sacrificing quality.

  1. No inventories/counts — stale instantly
  2. No directory trees — use 1-line path conventions
  3. No TOCs — AI reads linearly
  4. One example per pattern — only if non-obvious
  5. Lead with answer, not reasoning
  6. Sacrifice grammar for concision in reports
  7. Unresolved questions at end

AI Mistake Prevention — Failure modes to avoid:

Verify AI-generated content against actual code. AI hallucinates entity class names, property names, relationship types. Grep to confirm existence before documenting. Trace full dependency chain after edits. Always trace full chain. Holistic-first — resist nearest-attention trap. List EVERY precondition before forming hypothesis. Surface ambiguity before coding. NEVER pick silently.

IMPORTANT MUST ATTENTION read existing doc first, scan codebase, diff, surgical update only. Never rewrite entire doc.

IMPORTANT MUST ATTENTION output quality: no counts/trees/TOCs, 1 example per pattern, lead with answer.

MUST ATTENTION apply critical thinking — every claim needs traced proof, confidence >80% to act. Anti-hallucination: never present guess as fact.

MUST ATTENTION apply AI mistake prevention — holistic-first debugging, fix at responsible layer, surface ambiguity before coding, re-read files after compaction.

Closing Reminders

IMPORTANT MUST ATTENTION break work into small task tracking tasks BEFORE starting — one per sub-agent, one per service IMPORTANT MUST ATTENTION detect BOTH framework AND architecture type in Phase 0 — sub-agents depend on both IMPORTANT MUST ATTENTION cite file:line for every entity example — NEVER fabricate class names or property names IMPORTANT MUST ATTENTION sub-agents write findings incrementally after each service — NEVER batch at end IMPORTANT MUST ATTENTION coverage report is mandatory — list services with NO entities found IMPORTANT MUST ATTENTION when Round 1 finds issues, Round 2 fresh-eyes after fixing validates file:line and class names. Clean Round 1 ENDS the scan.

Anti-Rationalization:

Evasion Rebuttal
"Framework obvious, skip Phase 0 detection" Phase 0 is BLOCKING — entity patterns depend on detected framework
"Architecture type obvious from directory names" Verify from actual service structure — names are not evidence
"Verified 5 paths, that's enough" Glob-verify ALL entity paths — 5 is insufficient
"Cross-service agent not needed (monolith)" Confirm monolith from Phase 0 evidence before skipping Agent 4
"Coverage report not needed" Coverage report is a required section — list services with no entities found
"Skip Round 2 even when Round 1 found issues" Clean Round 1 ends the scan. When issues exist, fresh-eyes mandatory after fixing — main agent rationalizes own entity discoveries.

[TASK-PLANNING] Before acting, analyze task scope and break into small todo tasks and sub-tasks using task tracking.

Hookless Prompt Protocol Mirror (Auto-Synced)

Source: .claude/hooks/lib/prompt-injections.cjs + .claude/.ck.json

[WORKFLOW-EXECUTION-PROTOCOL] [BLOCKING] Workflow Execution Protocol — MANDATORY IMPORTANT MUST CRITICAL. Do not skip for any reason.

Generic portability boundary: Reusable skills and protocol text stay project-neutral; project-specific conventions are discovered from docs/project-config.json and docs/project-reference/. Apply shared AI-SDD from shared/sdd-artifact-contract.md. Read docs/project-config.json and docs/project-reference/docs-index-reference.md, then open the project reference docs named there. Any supported AI tool may execute when this shared context and local docs are available.

  1. DETECT: Match prompt against workflow catalog
  2. ANALYZE: Find best-match workflow AND evaluate if a custom step combination would fit better
  3. ASK (REQUIRED FORMAT): Use a direct user question with this structure unless the user explicitly invoked a workflow/skill and the local protocol treats explicit invocation as confirmation:
    • Question: "Which workflow do you want to activate?"
    • Option 1: "Activate [BestMatch Workflow] (Recommended)"
    • Option 2: "Activate custom workflow: [step1 → step2 → ...]" (include one-line rationale)
  4. ACTIVATE (if confirmed): Call $workflow-start <workflowId> for standard; sequence custom steps manually
  5. CREATE TASKS: task tracking for ALL workflow steps
  6. EXECUTE: Follow each step in sequence [CRITICAL-THINKING-MINDSET] Apply critical thinking, sequential thinking. Every claim needs traced proof, confidence >80% to act. Anti-hallucination principle: Never present guess as fact — cite sources for every claim, admit uncertainty freely, self-check output for errors, cross-reference independently, stay skeptical of own confidence — certainty without evidence root of all hallucination. AI Attention principle (Primacy-Recency): Put the 3 most critical rules at both top and bottom of long prompts/protocols so instruction adherence survives long context windows. Goal-driven execution: Define success criteria first, loop until verified, and stop only when observable checks pass. Tests verify intent: Tests must protect business rules/invariants and fail when the protected intent breaks, not only mirror current behavior.

[LESSON-LEARNED-REMINDER] [BLOCKING] Task Planning & Continuous Improvement — MANDATORY. Do not skip.

Break work into small tasks (task tracking) before starting. Add final task: "Analyze AI mistakes & lessons learned".

Extract lessons — ROOT CAUSE ONLY, not symptom fixes:

  1. Name the FAILURE MODE (reasoning/assumption failure), not symptom — "assumed API existed without reading source" not "used wrong enum value".
  2. Generality test: does this failure mode apply to ≥3 contexts/codebases? If not, abstract one level up.
  3. Write as a universal rule — strip project-specific names/paths/classes. Useful on any codebase.
  4. Consolidate: multiple mistakes sharing one failure mode → ONE lesson.
  5. Recurrence gate: "Would this recur in future session WITHOUT this reminder?" — No → skip $learn.
  6. Auto-fix gate: "Could $code-review/$code-simplifier/$security/$lint catch this?" — Yes → improve review skill instead.
  7. BOTH gates pass → ask user to run $learn. [TASK-PLANNING] [MANDATORY] BEFORE executing any workflow or skill step, create/update task tracking for all planned steps, then keep it synchronized as each step starts/completes.