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.
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
ADRdataclass withStatusenum, temporal fields, relations - Constitution Graph — cross-ADR dependency/supersession graph with cycle detection
- Audit — staleness checks, implementation evidence verification, drift detection
- CLI + MCP Server —
iil-adrfwCLI andiil-adrfw-mcpFastMCP 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:
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 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
# Audit constitution health
iil-adrfw audit docs/adr/
# Query ADRs by question/domain
iil-adrfw query docs/adr/ "Which ADR governs deployment?"
MCP Server (11 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
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 (date→decision_date, author→owner, 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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file iil_adrfw-0.6.0.tar.gz.
File metadata
- Download URL: iil_adrfw-0.6.0.tar.gz
- Upload date:
- Size: 142.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
74774dc9d6557ba9e59a6c058c25f45ab163f213f24037ad47a3bc1c79b9a72a
|
|
| MD5 |
39542ec9d46cfbdffa353d2ceaef70d4
|
|
| BLAKE2b-256 |
3f44cd068edd47ee72b5c1fe01d9d4cf0207bd519c82ff6a5c69654c3904ddfb
|
Provenance
The following attestation bundles were made for iil_adrfw-0.6.0.tar.gz:
Publisher:
publish.yml on achimdehnert/iil-adrfw
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
iil_adrfw-0.6.0.tar.gz -
Subject digest:
74774dc9d6557ba9e59a6c058c25f45ab163f213f24037ad47a3bc1c79b9a72a - Sigstore transparency entry: 1911156800
- Sigstore integration time:
-
Permalink:
achimdehnert/iil-adrfw@9c727065ce5d16bda3b87cec64607d237af76eb4 -
Branch / Tag:
refs/heads/session/2026-06-22/achim-dehnert/oidc-publish - Owner: https://github.com/achimdehnert
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@9c727065ce5d16bda3b87cec64607d237af76eb4 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file iil_adrfw-0.6.0-py3-none-any.whl.
File metadata
- Download URL: iil_adrfw-0.6.0-py3-none-any.whl
- Upload date:
- Size: 86.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cc435cd662b09cc9f42fb139616e09dc5981d6b83f76b09fda21fee5756d6cb1
|
|
| MD5 |
1dd400529b0c4bdbd3600f844e1b69e4
|
|
| BLAKE2b-256 |
f27a9099a3d538a6cc4f54c2ab7dabd256757a983fafbe8a027982eb87bfccab
|
Provenance
The following attestation bundles were made for iil_adrfw-0.6.0-py3-none-any.whl:
Publisher:
publish.yml on achimdehnert/iil-adrfw
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
iil_adrfw-0.6.0-py3-none-any.whl -
Subject digest:
cc435cd662b09cc9f42fb139616e09dc5981d6b83f76b09fda21fee5756d6cb1 - Sigstore transparency entry: 1911156956
- Sigstore integration time:
-
Permalink:
achimdehnert/iil-adrfw@9c727065ce5d16bda3b87cec64607d237af76eb4 -
Branch / Tag:
refs/heads/session/2026-06-22/achim-dehnert/oidc-publish - Owner: https://github.com/achimdehnert
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@9c727065ce5d16bda3b87cec64607d237af76eb4 -
Trigger Event:
workflow_dispatch
-
Statement type: