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.

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:

Mode Result
Strict load (validate=True) 152/156 (97.4%)
Unit tests 22/22 green
Remaining failures 4x broken YAML (unfixable)

Installation

pip install -e .

# With dev dependencies:
pip install -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 ADRs
iil-adrfw validate docs/adr/ --schemas schemas/

# Audit for staleness, missing evidence
iil-adrfw audit docs/adr/ --schemas schemas/

MCP Server

iil-adrfw-mcp

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

python examples/test_e2e_schema_v3.py   # Schema v3 tests (22 cases)
python examples/test_e2e.py              # Core tests
python examples/test_e2e_v11.py          # v1.1 format tests

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.3.1.tar.gz (124.7 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.3.1-py3-none-any.whl (71.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iil_adrfw-0.3.1.tar.gz
  • Upload date:
  • Size: 124.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for iil_adrfw-0.3.1.tar.gz
Algorithm Hash digest
SHA256 f4cf436882f94d6af80c1110481152f6adf00426c57e6831f8ff8172be63367e
MD5 6ab3592ecc041dc4b551f9288ac7837e
BLAKE2b-256 b3420cd83e3019f9350872d33025da7c86cbb1c010eb53423ec6582a2a793d41

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iil_adrfw-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 71.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for iil_adrfw-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 09a0ca7871e14f55a26fab3aff6ecbb18a598b9dc469d53520ff3fc7da222475
MD5 649c2cb1af5bf79dd6280d7b508293f0
BLAKE2b-256 c3661bbc401d884a8e36fa4a6b2b2f1c1dd716f1e859adbf3c76c6dc69e6337c

See more details on using hashes here.

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