# NarrativeTrace

> The first AI-ready logging library for Java. Code is the log — eliminate
> hand-written log statements from business logic. Your code's structure
> (method names, class names, parameters, call hierarchies) automatically
> becomes structured, AI-safe traces. Narrative/value separation prevents
> prompt injection and data leaks. Zero runtime dependencies in core.

## Docs
- [Getting Started](https://narrativetrace.ai/docs/getting-started.md): 5-minute quickstart — add NarrativeTrace to a Java project, capture first trace
- [Annotations](https://narrativetrace.ai/docs/annotations.md): @Narrated, @OnError, @NotTraced, @NarrativeSummary annotation reference
- [Capture Levels](https://narrativetrace.ai/docs/capture-levels.md): Five tracing levels — OFF, ERRORS, SUMMARY, NARRATIVE, DETAIL
- [Output Formats](https://narrativetrace.ai/docs/output-formats.md): Markdown, JSON, and prose rendering from a single trace capture
- [Clarity Diagnostics](https://narrativetrace.ai/docs/clarity.md): Code quality scoring from runtime narrative — naming analysis and clarity scores
- [Diagrams](https://narrativetrace.ai/docs/diagrams.md): Mermaid and PlantUML sequence diagram generation from traces

## Integrations
- [Spring Boot](https://narrativetrace.ai/docs/integrations/spring.md): @EnableNarrativeTrace, async support, Spring Boot starter
- [JUnit 5](https://narrativetrace.ai/docs/integrations/junit5.md): Per-test trace files, scenario framing, clarity reporting
- [JUnit 4](https://narrativetrace.ai/docs/integrations/junit4.md): @Rule-based integration for legacy test suites
- [Java Agent](https://narrativetrace.ai/docs/integrations/agent.md): Zero-code ASM bytecode transformation — no proxy wrapping needed
- [SLF4J Bridge](https://narrativetrace.ai/docs/integrations/slf4j.md): MDC fields (nt.class, nt.method, nt.depth), coexistence with existing logging
- [Micrometer](https://narrativetrace.ai/docs/integrations/micrometer.md): Cross-thread context propagation for @Async and CompletableFuture
- [Gradle Plugin](https://narrativetrace.ai/docs/integrations/gradle-plugin.md): clarityCheck and clarityScan tasks for CI integration

## Pro
- [Pro Overview](https://narrativetrace.ai/docs/pro/overview.md): Pro tier (early access) — aggregation, AI integration, compliance
- [Aggregation](https://narrativetrace.ai/docs/pro/aggregation.md): Flow summaries, migration diffs, path frequency analysis
- [Dependency Graphs](https://narrativetrace.ai/docs/pro/dependency-graphs.md): Runtime dependency visualization as Mermaid graphs
- [MCP Server](https://narrativetrace.ai/docs/pro/mcp.md): Model Context Protocol server for AI coding agents (Claude Code, Cursor) — coming soon
- [Audit & SecOps](https://narrativetrace.ai/docs/pro/audit.md): @AuditEvent, @SecurityEvent annotations, compliance policies
- [Audit Specification](https://narrativetrace.ai/docs/pro/audit-spec.md): Deterministic inference, field masking, data classification, sink routing

## Architecture
- [Narrative/Value Separation](https://narrativetrace.ai/docs/architecture/narrative-value-separation.md): Core design principle — separating structure from runtime values
- [Output Format Specification](https://narrativetrace.ai/docs/architecture/output-format-spec.md): Canonical JSON, Markdown, and prose format specs
- [Module Structure](https://narrativetrace.ai/docs/architecture/modules.md): Free and Pro module organization and dependencies

## Optional
- [Full Documentation](https://narrativetrace.ai/llms-full.txt): Complete documentation in a single file
- [Spanish landing page](https://narrativetrace.ai/es/): Overview in Spanish — the documentation itself is English only
- [Privacy Policy](https://narrativetrace.ai/privacy.html): What the website collects, why, and the rights over it — the NarrativeTrace libraries themselves send nothing anywhere
- [Cookie Policy](https://narrativetrace.ai/cookies.html): Every cookie and localStorage value the site stores, listed individually