sentinel-dv 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- sentinel_dv-1.0.0/LICENSE +201 -0
- sentinel_dv-1.0.0/PKG-INFO +412 -0
- sentinel_dv-1.0.0/README.md +367 -0
- sentinel_dv-1.0.0/pyproject.toml +110 -0
- sentinel_dv-1.0.0/sentinel_dv/__init__.py +29 -0
- sentinel_dv-1.0.0/sentinel_dv/config.py +206 -0
- sentinel_dv-1.0.0/sentinel_dv/ids.py +420 -0
- sentinel_dv-1.0.0/sentinel_dv/server.py +308 -0
- sentinel_dv-1.0.0/sentinel_dv/taxonomy_engine.py +463 -0
- sentinel_dv-1.0.0/sentinel_dv.egg-info/PKG-INFO +412 -0
- sentinel_dv-1.0.0/sentinel_dv.egg-info/SOURCES.txt +14 -0
- sentinel_dv-1.0.0/sentinel_dv.egg-info/dependency_links.txt +1 -0
- sentinel_dv-1.0.0/sentinel_dv.egg-info/entry_points.txt +3 -0
- sentinel_dv-1.0.0/sentinel_dv.egg-info/requires.txt +23 -0
- sentinel_dv-1.0.0/sentinel_dv.egg-info/top_level.txt +1 -0
- sentinel_dv-1.0.0/setup.cfg +4 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Sentinel DV Team
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,412 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sentinel-dv
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Security-first MCP server for verification intelligence (SystemVerilog/UVM/cocotb)
|
|
5
|
+
Author: Sentinel DV Team
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/kiranreddi/sentinel-dv
|
|
8
|
+
Project-URL: Documentation, https://github.com/kiranreddi/sentinel-dv
|
|
9
|
+
Project-URL: Repository, https://github.com/kiranreddi/sentinel-dv
|
|
10
|
+
Project-URL: Issues, https://github.com/kiranreddi/sentinel-dv/issues
|
|
11
|
+
Keywords: MCP,verification,UVM,SystemVerilog,cocotb,DV,EDA
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Topic :: Software Development :: Testing
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: fastmcp>=0.2.0
|
|
24
|
+
Requires-Dist: pydantic>=2.0.0
|
|
25
|
+
Requires-Dist: pyyaml>=6.0.0
|
|
26
|
+
Requires-Dist: python-dateutil>=2.8.0
|
|
27
|
+
Requires-Dist: duckdb>=0.9.0
|
|
28
|
+
Provides-Extra: dev
|
|
29
|
+
Requires-Dist: pytest>=7.4.0; extra == "dev"
|
|
30
|
+
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
|
|
31
|
+
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
|
|
32
|
+
Requires-Dist: pytest-timeout>=2.2.0; extra == "dev"
|
|
33
|
+
Requires-Dist: ruff>=0.1.0; extra == "dev"
|
|
34
|
+
Requires-Dist: mypy>=1.5.0; extra == "dev"
|
|
35
|
+
Requires-Dist: black>=23.9.0; extra == "dev"
|
|
36
|
+
Requires-Dist: types-pyyaml>=6.0.0; extra == "dev"
|
|
37
|
+
Requires-Dist: types-python-dateutil>=2.8.0; extra == "dev"
|
|
38
|
+
Provides-Extra: docs
|
|
39
|
+
Requires-Dist: mkdocs>=1.5.0; extra == "docs"
|
|
40
|
+
Requires-Dist: mkdocs-material>=9.4.0; extra == "docs"
|
|
41
|
+
Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.2.0; extra == "docs"
|
|
42
|
+
Requires-Dist: mkdocs-minify-plugin>=0.7.0; extra == "docs"
|
|
43
|
+
Requires-Dist: pymdown-extensions>=10.0; extra == "docs"
|
|
44
|
+
Dynamic: license-file
|
|
45
|
+
|
|
46
|
+
# 🛡️ Sentinel DV v1.0.0 - Verification Intelligence for AI Agents
|
|
47
|
+
|
|
48
|
+
<!-- mcp-name: io.github.kiranreddi/sentinel-dv -->
|
|
49
|
+
|
|
50
|
+
<div align="center">
|
|
51
|
+
|
|
52
|
+
[](https://www.python.org/downloads/)
|
|
53
|
+
[](https://modelcontextprotocol.io)
|
|
54
|
+
[](LICENSE)
|
|
55
|
+
[](https://github.com/kiranreddi/sentinel-dv/actions/workflows/ci.yml)
|
|
56
|
+
[](https://github.com/kiranreddi/sentinel-dv/actions/workflows/docs.yml)
|
|
57
|
+
[](CONTRIBUTING.md)
|
|
58
|
+
[](tests/)
|
|
59
|
+
|
|
60
|
+
**A security-first MCP server for verification intelligence (SystemVerilog/UVM/cocotb)**
|
|
61
|
+
|
|
62
|
+
[Features](#-features) • [Architecture](#-architecture) • [Quick Start](#-quick-start) • [Documentation](#-documentation)
|
|
63
|
+
|
|
64
|
+
</div>
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 🌟 What is Sentinel DV?
|
|
69
|
+
|
|
70
|
+
Sentinel DV is an **open-source Model Context Protocol (MCP) server** that provides large language models and AI agents with **safe, structured, read-only access** to verification artifacts—enabling deterministic triage, root-cause analysis, and verification insight without exposing raw logs or granting control of simulators.
|
|
71
|
+
|
|
72
|
+
### Verification Ecosystems Supported
|
|
73
|
+
|
|
74
|
+
- 🔧 **UVM (Universal Verification Methodology)** - Enterprise verification framework
|
|
75
|
+
- 🐍 **cocotb** - Python-based verification with coroutines
|
|
76
|
+
- 📊 **SystemVerilog** - Assertions, coverage, and native testbenches
|
|
77
|
+
- 🌊 **Waveform summaries** - Pre-computed signal analysis (no raw FSDB/VCD streaming)
|
|
78
|
+
|
|
79
|
+
All through a **unified, schema-driven interface** with built-in security, redaction, and deterministic outputs.
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## 🏗️ Architecture
|
|
84
|
+
|
|
85
|
+
Sentinel DV follows a **strict separation of concerns** with security-first principles:
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
sentinel_dv/
|
|
89
|
+
├── server.py # MCP server entrypoint
|
|
90
|
+
├── config.py # Security limits, feature flags, governance
|
|
91
|
+
├── registry.py # Tool registration and versioning
|
|
92
|
+
├── schemas/ # Typed contracts for all data
|
|
93
|
+
│ ├── common.py # EvidenceRef, RunRef, base types
|
|
94
|
+
│ ├── tests.py # TestCase, TestTopology, UvmTopology
|
|
95
|
+
│ ├── failures.py # FailureEvent, FailureSignature
|
|
96
|
+
│ ├── assertions.py # AssertionInfo, AssertionFailure
|
|
97
|
+
│ ├── coverage.py # CoverageSummary, CoverageMetric
|
|
98
|
+
│ ├── regressions.py # RegressionSummary, RunDiff
|
|
99
|
+
│ └── versioning.py # Schema version management
|
|
100
|
+
├── tools/ # MCP tools (discovery + detail)
|
|
101
|
+
│ ├── runs.py # runs.list, runs.diff
|
|
102
|
+
│ ├── tests.py # tests.list, tests.get, tests.topology
|
|
103
|
+
│ ├── failures.py # failures.list
|
|
104
|
+
│ ├── assertions.py # assertions.list/get/failures
|
|
105
|
+
│ ├── coverage.py # coverage.list/summary
|
|
106
|
+
│ ├── regressions.py # regressions.summary
|
|
107
|
+
│ └── wave.py # wave.summary, wave.signals
|
|
108
|
+
├── indexing/ # Artifact indexing and querying
|
|
109
|
+
│ ├── indexer.py # Build normalized index from artifacts
|
|
110
|
+
│ ├── store.py # DuckDB storage interface
|
|
111
|
+
│ └── query.py # Filter/sort/pagination
|
|
112
|
+
├── adapters/ # Parse verification artifacts
|
|
113
|
+
│ ├── uvm_log.py # UVM log parsing
|
|
114
|
+
│ ├── cocotb.py # cocotb result parsing
|
|
115
|
+
│ ├── assertions.py # Assertion map/failure parsing
|
|
116
|
+
│ ├── coverage.py # Coverage export parsing
|
|
117
|
+
│ └── waveform_summary.py # Waveform summary parsing
|
|
118
|
+
├── normalization/ # Security and determinism
|
|
119
|
+
│ ├── signatures.py # Stable failure signature hashing
|
|
120
|
+
│ ├── taxonomy.py # Failure categorization
|
|
121
|
+
│ └── redaction.py # Automatic secret/PII redaction
|
|
122
|
+
└── utils/ # Common utilities
|
|
123
|
+
├── hashing.py
|
|
124
|
+
├── time.py
|
|
125
|
+
└── bounded_text.py
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**Design Principles:**
|
|
129
|
+
- **Read-only by default** - No simulator control, no artifact modification
|
|
130
|
+
- **Schema-first** - Every response conforms to typed contracts
|
|
131
|
+
- **Deterministic** - Same input → same output (no LLM-generated fields)
|
|
132
|
+
- **Evidence-based** - All facts traceable to source artifacts
|
|
133
|
+
- **Bounded and safe** - Automatic redaction, size limits, path sandboxing
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## ✨ Features
|
|
138
|
+
|
|
139
|
+
### 🔒 Security First
|
|
140
|
+
- **Read-only by design** - No simulation triggers or artifact writes
|
|
141
|
+
- **Automatic redaction** - Credentials, tokens, emails, IP addresses, paths
|
|
142
|
+
- **Path sandboxing** - Only configured artifact roots accessible
|
|
143
|
+
- **Bounded outputs** - Max response sizes, max evidence excerpts
|
|
144
|
+
- **Provenance tracking** - Every fact includes optional source references
|
|
145
|
+
|
|
146
|
+
### 📊 Rich Verification Data
|
|
147
|
+
- **Test results** - Status, duration, seed, simulator info, DUT config
|
|
148
|
+
- **UVM topology** - Env/agent/driver/monitor/scoreboard hierarchy
|
|
149
|
+
- **Failure analysis** - Categorized events (assertion/scoreboard/protocol/timeout)
|
|
150
|
+
- **Assertion intelligence** - SVA definitions, runtime failures, intent mapping
|
|
151
|
+
- **Coverage metrics** - Functional/code/assertion/toggle/FSM coverage
|
|
152
|
+
- **Regression analytics** - Pass rates, failure signatures, run diffs
|
|
153
|
+
- **Interface bindings** - Protocol mapping (AXI/AHB/APB/PCIe/USB)
|
|
154
|
+
|
|
155
|
+
### ⚡ Performance & Scale
|
|
156
|
+
- **Efficient indexing** - DuckDB for fast filtering and aggregation
|
|
157
|
+
- **Smart pagination** - Bounded result sets with stable sorting
|
|
158
|
+
- **Normalized storage** - Deduplicated, hashed artifacts
|
|
159
|
+
- **Selective projection** - Request only needed fields
|
|
160
|
+
|
|
161
|
+
### 🔌 Simulator Agnostic
|
|
162
|
+
- Works with **any simulator** (Synopsys VCS, Cadence Xcelium, Mentor Questa, Verilator)
|
|
163
|
+
- **Adapter pattern** - Ingest tool-specific formats, output unified schemas
|
|
164
|
+
- **Pre-computed summaries** - No runtime dependency on EDA tools
|
|
165
|
+
|
|
166
|
+
### 📋 Schema-Driven Contracts
|
|
167
|
+
- **Versioned schemas** - SemVer with compatibility guarantees
|
|
168
|
+
- **JSON Schema validation** - Deterministic, testable
|
|
169
|
+
- **Stable tool APIs** - Backwards-compatible evolution
|
|
170
|
+
- **Self-documenting** - Schemas define the interface
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## 🚀 Quick Start
|
|
175
|
+
|
|
176
|
+
### Install from MCP Registry
|
|
177
|
+
|
|
178
|
+
Install via [uv](https://docs.astral.sh/uv/) (`uvx`) or your MCP client’s registry UI using server name `io.github.kiranreddi/sentinel-dv`.
|
|
179
|
+
|
|
180
|
+
**Claude Desktop / MCP client (stdio):**
|
|
181
|
+
|
|
182
|
+
```json
|
|
183
|
+
{
|
|
184
|
+
"mcpServers": {
|
|
185
|
+
"sentinel-dv": {
|
|
186
|
+
"command": "uvx",
|
|
187
|
+
"args": [
|
|
188
|
+
"--from",
|
|
189
|
+
"sentinel-dv",
|
|
190
|
+
"sentinel-dv-server",
|
|
191
|
+
"--config",
|
|
192
|
+
"/absolute/path/to/config.yaml"
|
|
193
|
+
]
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
Alternatively set `SENTINEL_DV_CONFIG` to your config path and omit `--config`.
|
|
200
|
+
|
|
201
|
+
**Before querying:** build the artifact index (required once per config):
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
uvx --from sentinel-dv sentinel-dv-index --config /absolute/path/to/config.yaml --index-all
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Installation
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
# Clone the repository
|
|
211
|
+
git clone https://github.com/kiranreddi/sentinel-dv.git
|
|
212
|
+
cd sentinel-dv
|
|
213
|
+
|
|
214
|
+
# Install with development dependencies
|
|
215
|
+
pip install -e ".[dev]"
|
|
216
|
+
|
|
217
|
+
# Or production install
|
|
218
|
+
pip install sentinel-dv
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### Configuration
|
|
222
|
+
|
|
223
|
+
Create a `config.yaml`:
|
|
224
|
+
|
|
225
|
+
```yaml
|
|
226
|
+
# Artifact roots (read-only)
|
|
227
|
+
artifact_roots:
|
|
228
|
+
- /path/to/verification/regressions
|
|
229
|
+
- /path/to/uvm/logs
|
|
230
|
+
|
|
231
|
+
# Index storage
|
|
232
|
+
index:
|
|
233
|
+
type: duckdb # or sqlite, json
|
|
234
|
+
path: ./sentinel_dv.db
|
|
235
|
+
|
|
236
|
+
# Adapters (enable/disable)
|
|
237
|
+
adapters:
|
|
238
|
+
uvm: true
|
|
239
|
+
cocotb: true
|
|
240
|
+
assertions: true
|
|
241
|
+
coverage: true
|
|
242
|
+
waveform_summary: false
|
|
243
|
+
|
|
244
|
+
# Security & limits
|
|
245
|
+
security:
|
|
246
|
+
max_response_bytes: 2097152 # 2MB
|
|
247
|
+
max_page_size: 200
|
|
248
|
+
max_evidence_refs: 10
|
|
249
|
+
max_excerpt_length: 1024
|
|
250
|
+
|
|
251
|
+
# Redaction
|
|
252
|
+
redaction:
|
|
253
|
+
enabled: true
|
|
254
|
+
patterns:
|
|
255
|
+
- AKIA.* # AWS keys
|
|
256
|
+
- ghp_.* # GitHub tokens
|
|
257
|
+
- Bearer\s+\S+ # Bearer tokens
|
|
258
|
+
redact_emails: true
|
|
259
|
+
redact_paths: true
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
### Running the Server
|
|
263
|
+
|
|
264
|
+
```bash
|
|
265
|
+
# Start the MCP server
|
|
266
|
+
python -m sentinel_dv.server --config config.yaml
|
|
267
|
+
|
|
268
|
+
# Index artifacts (one-time or scheduled)
|
|
269
|
+
python -m sentinel_dv.indexing.indexer --config config.yaml --index-all
|
|
270
|
+
|
|
271
|
+
# Run with Claude Desktop
|
|
272
|
+
# Add to Claude config:
|
|
273
|
+
{
|
|
274
|
+
"mcpServers": {
|
|
275
|
+
"sentinel-dv": {
|
|
276
|
+
"command": "python",
|
|
277
|
+
"args": ["-m", "sentinel_dv.server", "--config", "/path/to/config.yaml"]
|
|
278
|
+
}
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Example Queries
|
|
284
|
+
|
|
285
|
+
With Claude or any MCP client:
|
|
286
|
+
|
|
287
|
+
```
|
|
288
|
+
"Why did test axi_burst_test fail in the latest regression?"
|
|
289
|
+
→ Uses: tests.list, failures.list, tests.topology
|
|
290
|
+
|
|
291
|
+
"What assertions failed in the AXI agent?"
|
|
292
|
+
→ Uses: assertions.failures, assertions.get
|
|
293
|
+
|
|
294
|
+
"Compare coverage between runs R123 and R124"
|
|
295
|
+
→ Uses: runs.diff, coverage.summary
|
|
296
|
+
|
|
297
|
+
"Show me the failure signatures from the past week"
|
|
298
|
+
→ Uses: regressions.summary
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
---
|
|
302
|
+
|
|
303
|
+
## 📖 Documentation
|
|
304
|
+
|
|
305
|
+
### Core Concepts
|
|
306
|
+
- [Architecture Overview](docs/architecture.md) - Design principles and structure
|
|
307
|
+
- [Schema Reference](docs/schemas.md) - Complete type definitions
|
|
308
|
+
- [Tool Contracts](docs/tools/overview.md) - Request/response specifications
|
|
309
|
+
- [Security Model](docs/architecture/security.md) - Redaction, bounding, sandboxing
|
|
310
|
+
|
|
311
|
+
### Guides
|
|
312
|
+
- [Getting Started](docs/getting-started/quick-start.md) - Setup and first queries
|
|
313
|
+
- [Adapter Development](docs/adapters/custom.md) - Parse new artifact formats
|
|
314
|
+
- [Simulator Support](docs/simulator_support.md) - Vendor-specific notes
|
|
315
|
+
- [Deployment Guide](docs/deployment/production.md) - Production best practices
|
|
316
|
+
|
|
317
|
+
### Reference
|
|
318
|
+
- [API Documentation](https://yourusername.github.io/sentinel-dv/api/)
|
|
319
|
+
- [Configuration Reference](docs/configuration.md)
|
|
320
|
+
- [Examples](examples/) - Demo artifacts and clients
|
|
321
|
+
|
|
322
|
+
---
|
|
323
|
+
|
|
324
|
+
## 🤝 Contributing
|
|
325
|
+
|
|
326
|
+
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for:
|
|
327
|
+
- Code of Conduct
|
|
328
|
+
- Development setup
|
|
329
|
+
- Testing guidelines
|
|
330
|
+
- Pull request process
|
|
331
|
+
|
|
332
|
+
### Development
|
|
333
|
+
|
|
334
|
+
```bash
|
|
335
|
+
# Install with dev dependencies
|
|
336
|
+
pip install -e ".[dev]"
|
|
337
|
+
|
|
338
|
+
# Run tests
|
|
339
|
+
pytest
|
|
340
|
+
|
|
341
|
+
# Run with coverage
|
|
342
|
+
pytest --cov=sentinel_dv --cov-report=html
|
|
343
|
+
|
|
344
|
+
# Lint and format
|
|
345
|
+
ruff check .
|
|
346
|
+
black .
|
|
347
|
+
mypy sentinel_dv/
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
---
|
|
351
|
+
|
|
352
|
+
## 📊 Project Status
|
|
353
|
+
|
|
354
|
+
- ✅ **Core schemas** - Stable v1.0
|
|
355
|
+
- ✅ **MCP tools** - 15 tools across 5 categories
|
|
356
|
+
- ✅ **Adapters** - UVM, cocotb, assertions, coverage
|
|
357
|
+
- ✅ **Indexing** - DuckDB with efficient querying
|
|
358
|
+
- ✅ **Security** - Redaction, sandboxing, bounding
|
|
359
|
+
- ✅ **Test coverage** - 70%+ with unit and integration tests
|
|
360
|
+
- ✅ **Documentation** - Full guides and API reference
|
|
361
|
+
- 🚧 **Waveform summaries** - Experimental
|
|
362
|
+
- 🚧 **Plugin ecosystem** - Coming soon
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
## 🎯 Positioning
|
|
367
|
+
|
|
368
|
+
### What Sentinel DV **is**
|
|
369
|
+
- A **read-only MCP server** for verification ecosystems
|
|
370
|
+
- A **schema-first context provider** for agents and LLMs
|
|
371
|
+
- A **deterministic translation layer** from noisy artifacts to typed data
|
|
372
|
+
- A **composable infrastructure component** for debug workflows
|
|
373
|
+
|
|
374
|
+
### What Sentinel DV **is not**
|
|
375
|
+
- ❌ It does **not** start simulations or submit jobs
|
|
376
|
+
- ❌ It does **not** modify RTL/testbench code
|
|
377
|
+
- ❌ It does **not** require any specific simulator
|
|
378
|
+
- ❌ It is **not** an "AI that guesses"; it returns grounded, typed facts
|
|
379
|
+
|
|
380
|
+
---
|
|
381
|
+
|
|
382
|
+
## 🙏 Acknowledgments
|
|
383
|
+
|
|
384
|
+
Inspired by:
|
|
385
|
+
- [Sentinel CI](https://github.com/kiranreddi/sentinel-ci) - Universal CI/CD intelligence
|
|
386
|
+
- [Model Context Protocol](https://modelcontextprotocol.io) - Anthropic's agent-context standard
|
|
387
|
+
- The verification community using UVM, cocotb, and SystemVerilog
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
## 📄 License
|
|
392
|
+
|
|
393
|
+
Apache License 2.0 - see [LICENSE](LICENSE) for details.
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
## 🔗 Links
|
|
398
|
+
|
|
399
|
+
- 🌐 [Documentation](https://yourusername.github.io/sentinel-dv/)
|
|
400
|
+
- 💬 [Discussions](https://github.com/yourusername/sentinel-dv/discussions)
|
|
401
|
+
- 🐛 [Issue Tracker](https://github.com/yourusername/sentinel-dv/issues)
|
|
402
|
+
- 📣 [Changelog](CHANGELOG.md)
|
|
403
|
+
|
|
404
|
+
---
|
|
405
|
+
|
|
406
|
+
<div align="center">
|
|
407
|
+
|
|
408
|
+
**Built with ❤️ for the verification community**
|
|
409
|
+
|
|
410
|
+
[⬆ back to top](#️-sentinel-dv-v100---verification-intelligence-for-ai-agents)
|
|
411
|
+
|
|
412
|
+
</div>
|