agentleFS
michaelegnermichaelegner/architecture-intelligence-platform/CLAUDE.md

architecture-intelligence-platform

CLAUDE.md10 starsChanged 28 days agoApache-2.0View on GitHub

Architecture Intelligence Platform (AIP) is an evidence-qualified architecture knowledge layer: it ingests declared architecture (OpenAPI, AsyncAPI, an architecture manifest) and, optionally, runtime observation (OpenTelemetry traces), builds an Architecture Knowledge Graph in Neo4j, and answers questions about it through fixed deterministic Cypher analyses and a read-only natural-language query layer. Check ROADMAP.md for exactly what's shipped vs. planned before assuming a source type or capability is available. See docs/product-doctrine-and-strategic-direction.md for the full product doctrine and docs/architecture.md for the current system design —…

The file

We split this CLAUDE.md into the rules it gives an agent

7 rules. About 0 are common, 6 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Default to low ceremony. Do not spawn parallel Explore/subagents unless explicitly requested.

    line 34
  2. Distinctive:

    Do not start implementation, long trials or broad exploration until the owner asks.

    line 37
  3. Distinctive:

    Do not check out the PR or run broad test suites unless a material finding needs that evidence or the owner asks.

    line 39
  4. Very specific:

    Before editing a versioned specification or relying on branch/PR/release state, verify the target from live ROADMAP.md, git and GitHub …

    line 41
  5. Distinctive:

    Treat refactoring as part of normal Python implementation, not as a separate project phase.

    line 49
  6. Distinctive:

    Leave touched code simpler where there is a concrete maintainability benefit: remove unnecessary complexity or duplication, clarify …

    line 50
  7. Distinctive:

    Before opening a PR that changes Python code, briefly review the diff for material refactoring opportunities.

    line 59

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What this project is

Architecture Intelligence Platform (AIP) is an evidence-qualified architecture knowledge layer: it ingests declared architecture (OpenAPI, AsyncAPI, an architecture manifest) and, optionally, runtime observation (OpenTelemetry traces), builds an Architecture Knowledge Graph in Neo4j, and answers questions about it through fixed deterministic Cypher analyses and a read-only natural-language query layer. Check ROADMAP.md for exactly what's shipped vs. planned before assuming a source type or capability is available. See docs/product-doctrine-and-strategic-direction.md for the full product doctrine and docs/architecture.md for the current system design — this file does not restate either, since a restatement here is exactly what went stale last time (see "Repository status" below).

Governing sources and workflow

This repository is governed by, in authority order: product doctrine, then ROADMAP.md (authoritative for shipped-vs-planned release sequencing), then the current release's own specification (docs/specifications/<release>/specification.md and its iN-*.md increment specs; ROADMAP.md names the release in progress). See AGENTS.md for the full authority chain and the mandatory rules that follow from it.

For substantial specification-driven implementation work, follow AGENTS.md's reviewed-plan-then-implement-then-reconcile workflow via the specification-driven-implementation skill. Small maintenance changes that don't touch public contracts, identity, evidence, qualification, reconciliation, or release semantics don't need that full workflow — see AGENTS.md's exemption.

Working style

  • Default to low ceremony. Do not spawn parallel Explore/subagents unless explicitly requested; work sequentially.
  • For a "proposal", "suggestion" or "quick" answer, answer the decision first from cheap evidence. Do not start implementation, long trials or broad exploration until the owner asks.
  • A "review" or "quick review" is read-only by default: inspect the PR/diff and relevant files. Do not check out the PR or run broad test suites unless a material finding needs that evidence or the owner asks.
  • Before editing a versioned specification or relying on branch/PR/release state, verify the target from live ROADMAP.md, git and GitHub state rather than memory.

Pre-PR self-review requirements, including the strict documentation-only exemption, are defined once in AGENTS.md; follow them rather than duplicating that procedure here.

Continuous refactoring

Treat refactoring as part of normal Python implementation, not as a separate project phase. Leave touched code simpler where there is a concrete maintainability benefit: remove unnecessary complexity or duplication, clarify responsibilities, and prefer improving existing abstractions over speculative new ones. Keep improvements within the current task's scope; report larger structural concerns separately rather than expanding the change.

Preserve observable behavior, public contracts, deterministic results, and AIP's evidence, provenance, identity, qualification, and snapshot/observation-context semantics. Verify relevant behavior after any refactoring with the repository's existing checks.

Before opening a PR that changes Python code, briefly review the diff for material refactoring opportunities. Fix local, low-risk problems within scope; do not turn cosmetic preferences into blocking work. Skip this check for documentation-only changes. For substantial specification-driven work, follow the canonical skill's pre-PR refactoring check as part of the established workflow.

Repository status

docs/specifications/poc.md (and its siblings listed in docs/specifications/README.md: h1-h3-hardening.md, h4-opentelemetry.md, h5-open-source-readiness.md, 11h-runtime-correctness-robustness.md, 12g-public-repository-activation.md) is the original historical design input this project was built from — not the current governing specification. Every release since v0.2 has its own versioned specification under docs/specifications/<release>/. This file deliberately does not name the current release: ROADMAP.md is the single place that says which release is in progress, so it is the only place that has to change when one ships. Do not treat poc.md's scope statements (e.g. what's "out of scope for this PoC") as current — check ROADMAP.md instead, which is authoritative for what's actually shipped vs. planned per release.

Build/lint/test commands: uv sync, uv run pytest tests/unit, uv run pytest tests/integration, uv run ruff check ., uv run ruff format ., uv run pyright — see docs/development.md for the full local-dev workflow, including running without Docker and the Collector-based runtime demo.

Reference

  • docs/architecture.md — current system design: ingestion pipeline, runtime observation pipeline, graph write strategy.
  • docs/canonical-model.md — the shared Canonical Model every source adapter maps into.
  • docs/graph-model.md — Neo4j node labels, relationship types, import strategy.
  • docs/evidence.md — the Evidence/Provenance model and declared-vs-observed semantics.
  • docs/ingestion.md / docs/adapter-development.md — the source-adapter seam and what a new adapter must produce.
  • docs/analyses.md — the deterministic Cypher analyses (A1-A5 and beyond).
  • docs/mcp.md — the MCP tool/transport layer.
  • docs/opentelemetry.md — runtime trace ingestion and declared-vs-observed comparison.
  • docs/adr/ — the numbered architecture decision log (design rationale that doesn't belong in a living reference doc).
  • docs/specifications/README.md — the historical spec index, and a pointer to the current versioned specifications.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.