naja-scope 0.1.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.
Files changed (33) hide show
  1. naja_scope-0.1.0/LICENSE +201 -0
  2. naja_scope-0.1.0/PKG-INFO +161 -0
  3. naja_scope-0.1.0/README.md +136 -0
  4. naja_scope-0.1.0/pyproject.toml +51 -0
  5. naja_scope-0.1.0/setup.cfg +4 -0
  6. naja_scope-0.1.0/src/naja_scope/__init__.py +4 -0
  7. naja_scope-0.1.0/src/naja_scope/api.py +519 -0
  8. naja_scope-0.1.0/src/naja_scope/cards.py +190 -0
  9. naja_scope-0.1.0/src/naja_scope/cone.py +205 -0
  10. naja_scope-0.1.0/src/naja_scope/connectivity.py +121 -0
  11. naja_scope-0.1.0/src/naja_scope/errors.py +41 -0
  12. naja_scope-0.1.0/src/naja_scope/intent.py +157 -0
  13. naja_scope-0.1.0/src/naja_scope/loader.py +134 -0
  14. naja_scope-0.1.0/src/naja_scope/paging.py +59 -0
  15. naja_scope-0.1.0/src/naja_scope/resolve.py +248 -0
  16. naja_scope-0.1.0/src/naja_scope/server.py +226 -0
  17. naja_scope-0.1.0/src/naja_scope/session.py +175 -0
  18. naja_scope-0.1.0/src/naja_scope/snl.py +452 -0
  19. naja_scope-0.1.0/src/naja_scope/source_index.py +35 -0
  20. naja_scope-0.1.0/src/naja_scope.egg-info/PKG-INFO +161 -0
  21. naja_scope-0.1.0/src/naja_scope.egg-info/SOURCES.txt +31 -0
  22. naja_scope-0.1.0/src/naja_scope.egg-info/dependency_links.txt +1 -0
  23. naja_scope-0.1.0/src/naja_scope.egg-info/entry_points.txt +2 -0
  24. naja_scope-0.1.0/src/naja_scope.egg-info/requires.txt +2 -0
  25. naja_scope-0.1.0/src/naja_scope.egg-info/top_level.txt +1 -0
  26. naja_scope-0.1.0/tests/test_connectivity.py +102 -0
  27. naja_scope-0.1.0/tests/test_intent.py +202 -0
  28. naja_scope-0.1.0/tests/test_naming_and_source.py +76 -0
  29. naja_scope-0.1.0/tests/test_resolve.py +60 -0
  30. naja_scope-0.1.0/tests/test_tools.py +101 -0
  31. naja_scope-0.1.0/tests/test_zz_snapshot.py +157 -0
  32. naja_scope-0.1.0/tests/test_zzz_cone_cva6.py +59 -0
  33. naja_scope-0.1.0/tests/test_zzz_hierarchy_cva6.py +88 -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 [yyyy] [name of copyright owner]
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,161 @@
1
+ Metadata-Version: 2.4
2
+ Name: naja-scope
3
+ Version: 0.1.0
4
+ Summary: Agent-facing MCP query layer over najaeda: navigate elaborated SystemVerilog designs without loading source into context.
5
+ Author-email: naja authors <contact@keplertech.io>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/najaeda/naja-scope
8
+ Project-URL: Repository, https://github.com/najaeda/naja-scope
9
+ Project-URL: Issues, https://github.com/najaeda/naja-scope/issues
10
+ Keywords: mcp,systemverilog,eda,netlist,rtl,najaeda,llm,agent
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
18
+ Classifier: Topic :: Software Development :: Libraries
19
+ Requires-Python: >=3.10
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: najaeda>=0.7.8
23
+ Requires-Dist: mcp>=1.2
24
+ Dynamic: license-file
25
+
26
+ # naja-scope
27
+
28
+ Agent-facing query layer over [najaeda](https://github.com/najaeda/naja): an
29
+ MCP server whose tools let AI agents navigate elaborated SystemVerilog
30
+ designs — hierarchy, connectivity, drivers, cones, and source back-links —
31
+ without loading source code into context.
32
+
33
+ See [DESIGN.md](DESIGN.md) for architecture and scope;
34
+ [NAJAEDA_NOTES.md](NAJAEDA_NOTES.md) for upstream feature requests and bugs
35
+ found while building phase 1.
36
+
37
+ ## Status: phase 1 (structural spine + source ranges) + phase-2 intent layer
38
+
39
+ Phase 1 is the core; the phase-2 living-intent layer (`get_intent`, warm-only) is
40
+ productized — a thin, pyslang-free client over naja's in-engine SNL↔slang link
41
+ (`keep_ast_link`, shipped in najaeda 0.7.8). Its eval gate passed and was
42
+ re-confirmed on the productized layer (scope+intent ≤ grep turns on cva6-small;
43
+ see `docs/phase2-plan.md` §4). The DESIGN.md §3 workflow works end to end:
44
+
45
+ ```
46
+ resolve("uart_top.u_tx.tx_o") → term descriptor with src range
47
+ get_drivers("uart_top.tx_o") → { path: "uart_top.u_tx.tx_o_dff",
48
+ model: "naja_dff", pin: "Q",
49
+ src: "rtl/uart.sv:93-94" }
50
+ get_source("…tx_o_dff") → the always_ff block, ~5 lines
51
+ ```
52
+
53
+ Three calls, well under a thousand tokens, answer plus quotable source.
54
+
55
+ ## Install / run
56
+
57
+ ```sh
58
+ pip install naja-scope # pulls najaeda>=0.7.8 and mcp from PyPI
59
+ naja-scope-mcp # stdio MCP server
60
+ ```
61
+
62
+ Register with Claude Code:
63
+
64
+ ```sh
65
+ claude mcp add naja-scope -- naja-scope-mcp
66
+ ```
67
+
68
+ For development from a checkout, install editable instead:
69
+
70
+ ```sh
71
+ python3.11 -m venv .venv
72
+ .venv/bin/pip install -e .
73
+ ```
74
+
75
+ ## Tools
76
+
77
+ Lifecycle: `load_systemverilog` (files/flist/top), `load_verilog`,
78
+ `load_liberty`, `load_primitives`, `save_snapshot`, `load_snapshot`,
79
+ `reset_universe`, `status`.
80
+
81
+ Navigation: `resolve` (paths, bit selects, glob, did-you-mean),
82
+ `find` (design-wide glob, paginated), `get_hierarchy`.
83
+
84
+ Connectivity: `get_drivers`, `get_loads` (equipotential endpoints),
85
+ `trace_cone` (fanin/fanout combinational cone via naja `SNLLogicalCone`;
86
+ stop-at-flops/ports/black-boxes; counts + a `cross_hierarchy` summary naming the
87
+ frontier registers outside the cone root's subtree; lists bounded by
88
+ `max_frontier`).
89
+
90
+ Source & summaries: `get_source` (the SV lines that produced an object),
91
+ `get_module_card` (deterministic ports/counts/clock-reset card),
92
+ `get_stats` (per-model rollups).
93
+
94
+ Intent (phase 2): `get_intent` — source-level facts the netlist *erases in
95
+ lowering*: enum/typedef state names + encodings (incl. **package** typedefs whose
96
+ members live in another file), **packed struct/union** fields, and **symbolic
97
+ parameter expressions** (the formula behind a baked-in width). Backed by naja's
98
+ in-engine SNL↔slang link (`keep_ast_link`, najaeda 0.7.8) — a thin, pyslang-free
99
+ client that calls `naja.intent_*` and returns plain dicts; **no second
100
+ elaboration**. It is **warm-only** (a slang `Compilation` never serializes):
101
+ enable it with `load_intent`, `load_systemverilog(intent=true)` /
102
+ `load_snapshot(intent=true)`, or the `NAJA_SCOPE_INTENT=1` env opt-in; `status`
103
+ reports `intent_loaded` / `intent_loadable`. Cold sessions degrade gracefully
104
+ ("intent layer not loaded; source range available via get_source") and re-bind by
105
+ re-elaborating from the snapshot-persisted load spec. No extra Python dependency
106
+ (see DESIGN.md "Phase 2" + `docs/phase2-plan.md`).
107
+
108
+ Escape hatch: `query_python` — najaeda is the query language; recurring
109
+ patterns observed there get promoted to first-class tools.
110
+
111
+ Conventions (DESIGN.md §6): object references are hierarchical path strings;
112
+ every list is paginated (`limit`, `cursor`); responses carry
113
+ `src: "file:start-end"` where known; errors return structured suggestions.
114
+
115
+ ## How source ranges work today
116
+
117
+ Since najaeda 0.7.2 every SNL object exposes its SystemVerilog origin directly
118
+ in Python through `getSourceLoc()` (naja #389/#390). naja-scope walks the raw
119
+ designs once and reads those locations straight into a sidecar index keyed by
120
+ `(model, kind, name)` — no Verilog dump, no attribute reparsing. Anonymous
121
+ lowered objects (FFs, gates) are first given stable derived names (`tx_o_dff`
122
+ for the FF driving `tx_o`), which is also what makes them addressable by path.
123
+ The index serializes alongside the naja-if snapshot, so source ranges survive a
124
+ snapshot reload (fixed in 0.7.4) with no re-elaboration.
125
+
126
+ ## Scope
127
+
128
+ RTL/design questions on synthesizable SystemVerilog. Not a DV/testbench tool
129
+ (DESIGN.md §2 explains what is lost in lowering and why).
130
+
131
+ ## Development
132
+
133
+ ```sh
134
+ .venv/bin/python -m pytest tests/ -q
135
+ ```
136
+
137
+ The structural/source/snapshot tests are green on najaeda 0.7.4+ (no xfails):
138
+ the upstream bugs once tracked — parameter-specialization merging and naja-if
139
+ SV-snapshot reload — are both fixed (see NAJAEDA_NOTES.md); the snapshot
140
+ round-trip (`tests/test_zz_snapshot.py`) is a normal passing test.
141
+
142
+ naja-scope targets **najaeda 0.7.8** (on PyPI since 2026-06-28) — the in-engine
143
+ SNL↔slang link (`keep_ast_link`) + curated `intent_*` API behind `get_intent`,
144
+ the Python `NLID` value class + `NLUniverse.getObject(NLID)` that back its
145
+ object-identity model (`docs/identity-and-addressing.md`), and the 0.7.6 gate
146
+ combinatorial modeling `trace_cone` needs. A plain install runs the full suite:
147
+
148
+ ```sh
149
+ ./.venv/bin/python -m pytest -q
150
+ ```
151
+
152
+ For naja-side development you can instead run against a local naja build at
153
+ `/Users/xtof/WORK/naja3`, compiled for Homebrew Python 3.14 (it segfaults under a
154
+ 3.11 interpreter), via the `.venv314` dev venv plus `PYTHONPATH`:
155
+
156
+ ```sh
157
+ PYTHONPATH=/Users/xtof/WORK/naja3/build/test/najaeda ./.venv314/bin/python -m pytest -q
158
+ ```
159
+
160
+ The CVA6 cross-hierarchy cone regression (`tests/test_zzz_cone_cva6.py`) is
161
+ slow and skips unless the `eval/.cache/cva6-small` snapshot is present.
@@ -0,0 +1,136 @@
1
+ # naja-scope
2
+
3
+ Agent-facing query layer over [najaeda](https://github.com/najaeda/naja): an
4
+ MCP server whose tools let AI agents navigate elaborated SystemVerilog
5
+ designs — hierarchy, connectivity, drivers, cones, and source back-links —
6
+ without loading source code into context.
7
+
8
+ See [DESIGN.md](DESIGN.md) for architecture and scope;
9
+ [NAJAEDA_NOTES.md](NAJAEDA_NOTES.md) for upstream feature requests and bugs
10
+ found while building phase 1.
11
+
12
+ ## Status: phase 1 (structural spine + source ranges) + phase-2 intent layer
13
+
14
+ Phase 1 is the core; the phase-2 living-intent layer (`get_intent`, warm-only) is
15
+ productized — a thin, pyslang-free client over naja's in-engine SNL↔slang link
16
+ (`keep_ast_link`, shipped in najaeda 0.7.8). Its eval gate passed and was
17
+ re-confirmed on the productized layer (scope+intent ≤ grep turns on cva6-small;
18
+ see `docs/phase2-plan.md` §4). The DESIGN.md §3 workflow works end to end:
19
+
20
+ ```
21
+ resolve("uart_top.u_tx.tx_o") → term descriptor with src range
22
+ get_drivers("uart_top.tx_o") → { path: "uart_top.u_tx.tx_o_dff",
23
+ model: "naja_dff", pin: "Q",
24
+ src: "rtl/uart.sv:93-94" }
25
+ get_source("…tx_o_dff") → the always_ff block, ~5 lines
26
+ ```
27
+
28
+ Three calls, well under a thousand tokens, answer plus quotable source.
29
+
30
+ ## Install / run
31
+
32
+ ```sh
33
+ pip install naja-scope # pulls najaeda>=0.7.8 and mcp from PyPI
34
+ naja-scope-mcp # stdio MCP server
35
+ ```
36
+
37
+ Register with Claude Code:
38
+
39
+ ```sh
40
+ claude mcp add naja-scope -- naja-scope-mcp
41
+ ```
42
+
43
+ For development from a checkout, install editable instead:
44
+
45
+ ```sh
46
+ python3.11 -m venv .venv
47
+ .venv/bin/pip install -e .
48
+ ```
49
+
50
+ ## Tools
51
+
52
+ Lifecycle: `load_systemverilog` (files/flist/top), `load_verilog`,
53
+ `load_liberty`, `load_primitives`, `save_snapshot`, `load_snapshot`,
54
+ `reset_universe`, `status`.
55
+
56
+ Navigation: `resolve` (paths, bit selects, glob, did-you-mean),
57
+ `find` (design-wide glob, paginated), `get_hierarchy`.
58
+
59
+ Connectivity: `get_drivers`, `get_loads` (equipotential endpoints),
60
+ `trace_cone` (fanin/fanout combinational cone via naja `SNLLogicalCone`;
61
+ stop-at-flops/ports/black-boxes; counts + a `cross_hierarchy` summary naming the
62
+ frontier registers outside the cone root's subtree; lists bounded by
63
+ `max_frontier`).
64
+
65
+ Source & summaries: `get_source` (the SV lines that produced an object),
66
+ `get_module_card` (deterministic ports/counts/clock-reset card),
67
+ `get_stats` (per-model rollups).
68
+
69
+ Intent (phase 2): `get_intent` — source-level facts the netlist *erases in
70
+ lowering*: enum/typedef state names + encodings (incl. **package** typedefs whose
71
+ members live in another file), **packed struct/union** fields, and **symbolic
72
+ parameter expressions** (the formula behind a baked-in width). Backed by naja's
73
+ in-engine SNL↔slang link (`keep_ast_link`, najaeda 0.7.8) — a thin, pyslang-free
74
+ client that calls `naja.intent_*` and returns plain dicts; **no second
75
+ elaboration**. It is **warm-only** (a slang `Compilation` never serializes):
76
+ enable it with `load_intent`, `load_systemverilog(intent=true)` /
77
+ `load_snapshot(intent=true)`, or the `NAJA_SCOPE_INTENT=1` env opt-in; `status`
78
+ reports `intent_loaded` / `intent_loadable`. Cold sessions degrade gracefully
79
+ ("intent layer not loaded; source range available via get_source") and re-bind by
80
+ re-elaborating from the snapshot-persisted load spec. No extra Python dependency
81
+ (see DESIGN.md "Phase 2" + `docs/phase2-plan.md`).
82
+
83
+ Escape hatch: `query_python` — najaeda is the query language; recurring
84
+ patterns observed there get promoted to first-class tools.
85
+
86
+ Conventions (DESIGN.md §6): object references are hierarchical path strings;
87
+ every list is paginated (`limit`, `cursor`); responses carry
88
+ `src: "file:start-end"` where known; errors return structured suggestions.
89
+
90
+ ## How source ranges work today
91
+
92
+ Since najaeda 0.7.2 every SNL object exposes its SystemVerilog origin directly
93
+ in Python through `getSourceLoc()` (naja #389/#390). naja-scope walks the raw
94
+ designs once and reads those locations straight into a sidecar index keyed by
95
+ `(model, kind, name)` — no Verilog dump, no attribute reparsing. Anonymous
96
+ lowered objects (FFs, gates) are first given stable derived names (`tx_o_dff`
97
+ for the FF driving `tx_o`), which is also what makes them addressable by path.
98
+ The index serializes alongside the naja-if snapshot, so source ranges survive a
99
+ snapshot reload (fixed in 0.7.4) with no re-elaboration.
100
+
101
+ ## Scope
102
+
103
+ RTL/design questions on synthesizable SystemVerilog. Not a DV/testbench tool
104
+ (DESIGN.md §2 explains what is lost in lowering and why).
105
+
106
+ ## Development
107
+
108
+ ```sh
109
+ .venv/bin/python -m pytest tests/ -q
110
+ ```
111
+
112
+ The structural/source/snapshot tests are green on najaeda 0.7.4+ (no xfails):
113
+ the upstream bugs once tracked — parameter-specialization merging and naja-if
114
+ SV-snapshot reload — are both fixed (see NAJAEDA_NOTES.md); the snapshot
115
+ round-trip (`tests/test_zz_snapshot.py`) is a normal passing test.
116
+
117
+ naja-scope targets **najaeda 0.7.8** (on PyPI since 2026-06-28) — the in-engine
118
+ SNL↔slang link (`keep_ast_link`) + curated `intent_*` API behind `get_intent`,
119
+ the Python `NLID` value class + `NLUniverse.getObject(NLID)` that back its
120
+ object-identity model (`docs/identity-and-addressing.md`), and the 0.7.6 gate
121
+ combinatorial modeling `trace_cone` needs. A plain install runs the full suite:
122
+
123
+ ```sh
124
+ ./.venv/bin/python -m pytest -q
125
+ ```
126
+
127
+ For naja-side development you can instead run against a local naja build at
128
+ `/Users/xtof/WORK/naja3`, compiled for Homebrew Python 3.14 (it segfaults under a
129
+ 3.11 interpreter), via the `.venv314` dev venv plus `PYTHONPATH`:
130
+
131
+ ```sh
132
+ PYTHONPATH=/Users/xtof/WORK/naja3/build/test/najaeda ./.venv314/bin/python -m pytest -q
133
+ ```
134
+
135
+ The CVA6 cross-hierarchy cone regression (`tests/test_zzz_cone_cva6.py`) is
136
+ slow and skips unless the `eval/.cache/cva6-small` snapshot is present.
@@ -0,0 +1,51 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "naja-scope"
7
+ version = "0.1.0"
8
+ description = "Agent-facing MCP query layer over najaeda: navigate elaborated SystemVerilog designs without loading source into context."
9
+ readme = "README.md"
10
+ license = "Apache-2.0"
11
+ license-files = ["LICENSE"]
12
+ requires-python = ">=3.10"
13
+ authors = [
14
+ { name = "naja authors", email = "contact@keplertech.io" },
15
+ ]
16
+ keywords = ["mcp", "systemverilog", "eda", "netlist", "rtl", "najaeda", "llm", "agent"]
17
+ classifiers = [
18
+ "Development Status :: 4 - Beta",
19
+ "Intended Audience :: Developers",
20
+ "Operating System :: OS Independent",
21
+ "Programming Language :: Python :: 3",
22
+ "Programming Language :: Python :: 3.10",
23
+ "Programming Language :: Python :: 3.11",
24
+ "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
25
+ "Topic :: Software Development :: Libraries",
26
+ ]
27
+ dependencies = [
28
+ "najaeda>=0.7.8",
29
+ "mcp>=1.2",
30
+ ]
31
+
32
+ [project.urls]
33
+ Homepage = "https://github.com/najaeda/naja-scope"
34
+ Repository = "https://github.com/najaeda/naja-scope"
35
+ Issues = "https://github.com/najaeda/naja-scope/issues"
36
+
37
+ # Phase-2 living-intent layer (get_intent) needs NO extra Python dependency: it
38
+ # is a thin client over naja's in-engine SNL↔slang link (naja.intent_*), which
39
+ # walks the live slang AST in C++ and returns plain data. There is no pyslang
40
+ # and no second elaboration. The only requirement is a najaeda build that
41
+ # retains the link (keep_ast_link); warm-only. See
42
+ # docs/naja-feature-request-slang-coupling.md and DESIGN.md "Phase 2".
43
+
44
+ [project.scripts]
45
+ naja-scope-mcp = "naja_scope.server:main"
46
+
47
+ [tool.setuptools.packages.find]
48
+ where = ["src"]
49
+
50
+ [tool.pytest.ini_options]
51
+ testpaths = ["tests"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,4 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ """naja-scope: agent-facing MCP query layer over najaeda."""
3
+
4
+ __version__ = "0.1.0"