Skip to main content

Sentinel DV

PyPI MCP Registry CI Documentation License

Sentinel DV v2.3.1 is a read-only Model Context Protocol server for design verification evidence. It indexes exported SystemVerilog, UVM, cocotb, assertion, coverage, regression, and waveform artifacts into DuckDB and exposes 28 bounded, schema-driven tools to AI agents.

Documentation | Quick start | Video walkthrough | All tools | Agent skills

What it provides

  • Run and test intelligence: discovery, summaries, history, topology, diffs, replay-command generation, and live-status snapshots.
  • Failure analysis: normalized categories, stable signatures, bounded evidence, assertion failures, and failure clustering.
  • Coverage closure: functional, code, toggle, and FSM metrics; trends; gaps; vacuity; SVA status; and protocol-aware constraint candidates.
  • Waveform context: precomputed *.wave.json and bounded VCD summaries. Native FSDB/WLF streaming is intentionally out of scope.
  • Agent workflows: regression triage, single-test failure debugging, and coverage closure skills for Codex, Claude Code, and GitHub Copilot.

Sentinel DV does not execute simulations, modify RTL or testbench files, or stream unrestricted raw artifacts. runs.submit and tests.replay return dry-run commands for engineer review.

Quick start

Python 3.10 or newer is required. This example indexes the checked-in demo corpus:

For a persistent environment, install sentinel-dv>=2.3.1. The commands below use uvx to run the same release without a persistent install.

git clone https://github.com/kiranreddi/sentinel-dv.git
cd sentinel-dv
cp demo/config.example.yaml demo/config.yaml

uvx --from sentinel-dv@2.3.1 \
  sentinel-dv-index --config "$PWD/demo/config.yaml" --index-all

Connect one agent:

Codex

codex mcp add sentinel-dv \
  --env SENTINEL_DV_CONFIG="$PWD/demo/config.yaml" \
  -- uvx --from sentinel-dv@2.3.1 sentinel-dv-server

Claude Code

claude mcp add \
  --env SENTINEL_DV_CONFIG="$PWD/demo/config.yaml" \
  --transport stdio --scope local sentinel-dv \
  -- uvx --from sentinel-dv@2.3.1 sentinel-dv-server

GitHub Copilot CLI

copilot mcp add sentinel-dv \
  --env SENTINEL_DV_CONFIG="$PWD/demo/config.yaml" \
  -- uvx --from sentinel-dv@2.3.1 sentinel-dv-server

Use an absolute SENTINEL_DV_CONFIG path. Verify the connection in the client's MCP status view, then call runs.list.

See Agent setup for configuration-file examples, project scope, skill discovery, and troubleshooting.

Production configuration

Copy config.example.yaml and define allowed artifact roots:

artifact_roots:
  - /absolute/path/to/regression/artifacts

index:
  type: duckdb
  path: ./sentinel_dv.db

adapters:
  uvm: true
  cocotb: true
  assertions: true
  coverage: true
  waveform_summary: true

security:
  max_response_bytes: 2097152
  max_page_size: 200
  max_evidence_refs: 10

redaction:
  enabled: true
  redact_emails: true
  redact_paths: true

Build the index before starting the server:

sentinel-dv-index --config /absolute/path/to/config.yaml --index-all
sentinel-dv-server --config /absolute/path/to/config.yaml

Relative paths inside the YAML are resolved from the config file's directory. Production startup never silently falls back to demo data.

MCP tools

The 28 tools are grouped by engineering purpose:

Area Tools
Runs runs.list, runs.get, runs.summary, runs.diff, runs.cross_sim, runs.submit
Tests tests.list, tests.get, tests.history, tests.topology, tests.cluster, tests.replay
Failures and assertions failures.list, assertions.list, assertions.get, assertions.failures, assertions.sva_status, assertions.vacuity
Coverage coverage.list, coverage.summary, coverage.gaps, coverage.trend, coverage.advisor
Regression and simulation regressions.summary, regression.health, sim.status
Waveforms wave.signals, wave.summary

Every registered tool carries read-only MCP annotations and a versioned output schema. The MCP tools reference documents exact inputs and outputs.

Agent skills

The canonical skills live under skills/:

Deterministic mirrors support project discovery:

Host Path
Codex .agents/skills/
Claude Code .claude/skills/
GitHub Copilot .github/skills/

The repository also contains Codex and Claude plugin manifests. .mcp.json defines the bundled stdio server command; provide SENTINEL_DV_CONFIG or a config.yaml in the server working directory.

After editing a canonical skill:

.venv/bin/python scripts/sync_agent_skills.py
.venv/bin/python scripts/sync_agent_skills.py --check

Supported artifact sources

  • UVM logs and topology hints
  • cocotb and generic JUnit XML
  • assertion definition and failure JSON
  • SVA run-status JSON
  • supported JSON, XML, text, and HTML coverage summaries
  • *.wave.json and VCD
  • live simulation status JSON
  • exported VCS, Xcelium, Questa, and Verilator results

Adapter output is normalized into versioned schemas so clients do not need vendor-specific parsing logic.

Security model

  • Tools are read-only and operate on an index plus configured artifact roots.
  • Path resolution is sandboxed to allowed roots.
  • Evidence counts, excerpts, pages, wave signals, bins, and total response size are bounded.
  • Configurable redaction protects common secrets, email addresses, IP addresses, and local paths.
  • Tool output is deterministic; the MCP server does not generate causal conclusions.

Read Security and Production deployment before using production artifacts.

Verification

Create a development environment:

python3 -m venv .venv
.venv/bin/pip install -e ".[dev,docs]"

Run endpoint and workflow checks:

.venv/bin/python scripts/verify_all_mcp_tools.py
.venv/bin/python scripts/verify_skill_workflows.py

Run the full quality suite:

.venv/bin/pytest
.venv/bin/ruff check .
.venv/bin/black --check .
.venv/bin/mypy sentinel_dv
.venv/bin/mkdocs build --strict

The all-tools verifier invokes every registered MCP endpoint. The skill verifier indexes 52 checked-in demo artifacts and executes the published regression triage, failure debugging, and coverage closure sequences.

Project layout

sentinel_dv/
  adapters/        artifact parsers
  indexing/        DuckDB indexing and queries
  normalization/   signatures, taxonomy, redaction, coverage guidance
  schemas/         versioned response contracts
  tools/core.py    tool implementations
  server.py        FastMCP registration and stdio entry point

skills/            canonical agent skills
demo/              license-free exported verification fixtures
docs/              MkDocs documentation
scripts/           verification, gallery, release, and skill-sync tooling
tests/             unit and integration coverage

Contributing

See CONTRIBUTING.md. Sentinel DV is licensed under Apache-2.0.

Download files

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

Source Distribution

sentinel_dv-2.3.1.tar.gz (113.1 kB view details)

Uploaded Source

Built Distribution

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

sentinel_dv-2.3.1-py3-none-any.whl (128.4 kB view details)

Uploaded Python 3

File details

Details for the file sentinel_dv-2.3.1.tar.gz.

File metadata

  • Download URL: sentinel_dv-2.3.1.tar.gz
  • Upload date:
  • Size: 113.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.10.20

File hashes

Hashes for sentinel_dv-2.3.1.tar.gz
Algorithm Hash digest
SHA256 260e25d78251daaa12a3f5b4cd79e203dbae304f095c14d83fc58e4d34a8e0cc
MD5 b19badd58475381d9f2349937d3a893b
BLAKE2b-256 c970a9dfdfe242c24ad177e035127151311af38a3568e1ccafef832be25f1ff7

See more details on using hashes here.

File details

Details for the file sentinel_dv-2.3.1-py3-none-any.whl.

File metadata

  • Download URL: sentinel_dv-2.3.1-py3-none-any.whl
  • Upload date:
  • Size: 128.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.10.20

File hashes

Hashes for sentinel_dv-2.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0f97bb6f6923c559c0ddacec30ee1c94ff0b94b222623f83693ead60d2bfa36f
MD5 5962f6269d0514b6828cd3f5837feebe
BLAKE2b-256 29dc14ffc540af5911691c8a358a735f19e3aa78271ad7a84a5d65a4b2179c23

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.3.1 This release

2 files

2.3.0

2 files

2.2.0

2 files

1.3.1

2 files

1.3.0

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page