Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

ADR Discovery

ADR Discovery inventories AI tooling on an endpoint, including AI binaries, desktop applications, agents, MCP servers, skills, plugins, and related programmable surfaces. It records the evidence behind each finding and reports coverage gaps so an incomplete scan is not mistaken for a clean machine.

The collector runs on Python 3.11+ and has no runtime dependencies outside the standard library.

Quick start

Run a scan from this directory with uv:

uv run adr-discovery --dry-run --json

To see exactly what the collector would emit without writing a snapshot:

uv run adr-discovery --dry-run --explain

Use --output-dir to save scan output:

uv run adr-discovery --output-dir ./output

Run uv run adr-discovery --help for all options.

Common workflows

Scan a fixture tree instead of the live endpoint:

uv run adr-discovery --root /path/to/fixture --dry-run --json

Compare the current scan with an earlier snapshot:

uv run adr-discovery --diff /path/to/snapshot.json --dry-run --json

Apply a tenant policy or last-used telemetry during a scan:

uv run adr-discovery \
  --policy /path/to/policy.json \
  --telemetry /path/to/telemetry.json \
  --dry-run --json

Discovery does not execute binaries that it finds. Machine access is bounded, and risky text is redacted at collection time.

Exit codes

Code Meaning
0 The scan completed with full available coverage.
2 The scan completed, but one or more surfaces were unavailable, unreadable, or truncated. A snapshot is still produced.
Other The command could not complete because of an error or invalid input.

Development

Install the development dependencies and run the checks:

uv sync --extra dev
uv run pytest -q
uv run ruff check .

The test suite has two layers:

  • adr_discovery/tests_unit/ verifies modules, contracts, security boundaries, and the composed pipeline.
  • tests/ is the black-box endpoint harness used to compare known installations with the collector's reported snapshot.

Project layout

adr_discovery/
  catalog/       known-tool catalog and validation
  contracts/     shared records, evidence, and snapshot types
  coverage/      coverage accounting
  enumerator/    endpoint source enumeration
  extractor/     declaration and surface extraction
  identifier/    evidence-based identification
  judge/         risk, sanction, and finding evaluation
  redact/        sensitive-data redaction
  reporter/      snapshots and deltas
  resolver/      observation merging and confidence
  world/         bounded, platform-specific machine access
  cli.py         command-line interface
  pipeline.py    pipeline composition
tests/           black-box endpoint test harness

For the architecture, data model, security boundaries, current limitations, and implementation details, see the package documentation. For end-to-end validation and VM provisioning, see the test harness documentation.

License

Apache-2.0.