Skip to main content

Architectural Decision Record framework with bi-temporal validity, AST checkers, and FastMCP integration

Project description

iil-adrfw

ADR Framework for the IIL Platform — schema validation, loader normalization, constitution graph, audit tooling.

PyPI Python 3.12+ License: MIT

What it does

  • Schema v3 — strict JSON Schema for ADR frontmatter with additionalProperties: false
  • Phase 1 Normalizer — 15+ field aliases, status normalization, type coercion, reference extraction
  • Phase 2 Validator — jsonschema validation against adr_frontmatter.schema.json
  • Phase 3 Domain — typed ADR dataclass with Status enum, temporal fields, relations
  • Constitution Graph — cross-ADR dependency/supersession graph with cycle detection
  • Audit — staleness checks, implementation evidence verification, drift detection
  • CLI + MCP Serveriil-adrfw CLI and iil-adrfw-mcp FastMCP server

Real-world validation

Tested against 156 real platform ADRs (as of v0.3.1):

Mode Result
Schema validation 156/156 (100%)
Staleness (>6mo) 0 stale
Broken references 0
Dependency edges 31

Installation

pip install iil-adrfw

# From source with dev dependencies:
python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

# PEP-668-managed hosts without a venv (fallback only):
pip install --user --break-system-packages -e ".[dev]"

Usage

Python API

from pathlib import Path
from iil_adrfw.persistence import load_adr, load_adrs

# Load single ADR
adr = load_adr(Path("docs/adr/ADR-099.md"), Path("schemas/"))

# Load all ADRs in directory
adrs = load_adrs(Path("docs/adr/"), Path("schemas/"))

# Diagnosis mode (skip normalization)
raw_adr = load_adr(path, schemas, raw=True)

CLI

# Validate all ADR frontmatters against schema v3
iil-adrfw validate docs/adr/

# Check staleness (>6 months), broken references, missing reviews
iil-adrfw staleness docs/adr/ --months 6

# Generate dependency graph (text, DOT, or JSON)
iil-adrfw graph docs/adr/ --dot > graph.dot

# Export Outline-compatible markdown registry
iil-adrfw export docs/adr/ -o adr-registry.md

# Render the INDEX.md table (ADR-138 Impl column); --table-only for the bare block
iil-adrfw index docs/adr/ -o docs/adr/INDEX.md

# Audit constitution health
iil-adrfw audit docs/adr/

# Query ADRs by question/domain
iil-adrfw query docs/adr/ "Which ADR governs deployment?"

# Compute Schema v4 controlling metrics and print a report
iil-adrfw metrics --adr-dir docs/adr/ --report

MCP Server (12 tools)

iil-adrfw-mcp  # stdio transport, register in Windsurf mcp_config.json

Tools: adr_validate, adr_staleness, adr_impact, adr_check, adr_explain, adr_query, adr_audit, adr_validate_cross_repo, adr_propose, adr_diff, adr_narrate, adr_freshness

Schema v3 highlights

  • 5 new fields: updated, version, review_status, owner, implementation_done_when
  • 3 removed fields: glossary, review_cadence, next_review_date
  • Status enum: {draft, proposed, accepted, deprecated, superseded, rejected, experimental}
  • Implementation status: {none, planned, in_progress, partial, implemented, complete, verified, rolled_back}

Loader normalizations (Phase 1)

Step What
C.1 12 field aliases (datedecision_date, authorowner, etc.)
C.2 Status normalization (case, suffixes)
C.3 Scalar-to-list auto-wrapping
C.4 Reference field normalization (ADR-NNN extraction)
C.5 ID inference, title inference, domains default, deciders default
C.6 Amended-format normalization
C.7 implemented field → implementation_status mapping
C.8 Strip unknown properties

See SCHEMA_V3_SPEC.md for full specification.

Running tests

make test   # python3 -m pytest examples/  (the full suite lives in examples/)

Project structure

iil-adrfw/
├── schemas/                    # JSON Schema files
│   ├── adr_frontmatter.schema.json
│   ├── adr_rules.schema.json
│   └── constitution.schema.json
├── src/iil_adrfw/
│   ├── persistence/            # Loader (normalize + validate + construct)
│   ├── domain/                 # ADR dataclass, Status enum
│   ├── graph/                  # Constitution graph
│   ├── audit/                  # Staleness, evidence checks
│   ├── checkers/               # AST-based code checkers
│   ├── cli.py                  # CLI entry point
│   └── server.py               # FastMCP server
├── examples/                   # Example ADRs + test suites
├── SCHEMA_V3_SPEC.md          # Full v3 specification
└── SCHEMA_V3_CHANGELOG.md     # Changelog for downstream consumers

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iil_adrfw-0.7.0.tar.gz (169.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iil_adrfw-0.7.0-py3-none-any.whl (89.3 kB view details)

Uploaded Python 3

File details

Details for the file iil_adrfw-0.7.0.tar.gz.

File metadata

  • Download URL: iil_adrfw-0.7.0.tar.gz
  • Upload date:
  • Size: 169.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for iil_adrfw-0.7.0.tar.gz
Algorithm Hash digest
SHA256 f758d6a873284b82f0f382924f4390e98178774d69b285895a922e97cf73c50d
MD5 0a432dc94609e0b06d1328042369d3df
BLAKE2b-256 6f38ca713e660c2707b0f3df37f6abf3fde3327491f4413a5961036d8a6e3689

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_adrfw-0.7.0.tar.gz:

Publisher: publish.yml on achimdehnert/iil-adrfw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file iil_adrfw-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: iil_adrfw-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 89.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for iil_adrfw-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a3f052b01008addc13582c67aefd13a9e82d9526f7215915da3b50bcf523cc57
MD5 0bef9615ff2e245ac2f02a8d9bc4de91
BLAKE2b-256 7f0c55d445abaf010913a3df5dd1ef3f0acde0fa2ddb01fb086292aa2c3fee8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_adrfw-0.7.0-py3-none-any.whl:

Publisher: publish.yml on achimdehnert/iil-adrfw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page