@intelligentelectron/universal-netlist 0.0.12

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 (105) hide show
  1. package/CHANGELOG.md +121 -0
  2. package/LICENSE +190 -0
  3. package/NOTICE +4 -0
  4. package/README.md +246 -0
  5. package/dist/circuit-traversal.d.ts +73 -0
  6. package/dist/circuit-traversal.d.ts.map +1 -0
  7. package/dist/circuit-traversal.js +299 -0
  8. package/dist/circuit-traversal.js.map +1 -0
  9. package/dist/cli/commands.d.ts +23 -0
  10. package/dist/cli/commands.d.ts.map +1 -0
  11. package/dist/cli/commands.js +140 -0
  12. package/dist/cli/commands.js.map +1 -0
  13. package/dist/cli/prompts.d.ts +10 -0
  14. package/dist/cli/prompts.d.ts.map +1 -0
  15. package/dist/cli/prompts.js +22 -0
  16. package/dist/cli/prompts.js.map +1 -0
  17. package/dist/cli/shell.d.ts +15 -0
  18. package/dist/cli/shell.d.ts.map +1 -0
  19. package/dist/cli/shell.js +66 -0
  20. package/dist/cli/shell.js.map +1 -0
  21. package/dist/cli/updater.d.ts +46 -0
  22. package/dist/cli/updater.d.ts.map +1 -0
  23. package/dist/cli/updater.js +319 -0
  24. package/dist/cli/updater.js.map +1 -0
  25. package/dist/index.d.ts +16 -0
  26. package/dist/index.d.ts.map +1 -0
  27. package/dist/index.js +63 -0
  28. package/dist/index.js.map +1 -0
  29. package/dist/parsers/altium/connectivity.d.ts +32 -0
  30. package/dist/parsers/altium/connectivity.d.ts.map +1 -0
  31. package/dist/parsers/altium/connectivity.js +308 -0
  32. package/dist/parsers/altium/connectivity.js.map +1 -0
  33. package/dist/parsers/altium/discovery.d.ts +30 -0
  34. package/dist/parsers/altium/discovery.d.ts.map +1 -0
  35. package/dist/parsers/altium/discovery.js +174 -0
  36. package/dist/parsers/altium/discovery.js.map +1 -0
  37. package/dist/parsers/altium/hierarchy.d.ts +29 -0
  38. package/dist/parsers/altium/hierarchy.d.ts.map +1 -0
  39. package/dist/parsers/altium/hierarchy.js +94 -0
  40. package/dist/parsers/altium/hierarchy.js.map +1 -0
  41. package/dist/parsers/altium/index.d.ts +53 -0
  42. package/dist/parsers/altium/index.d.ts.map +1 -0
  43. package/dist/parsers/altium/index.js +404 -0
  44. package/dist/parsers/altium/index.js.map +1 -0
  45. package/dist/parsers/altium/net-extractor.d.ts +24 -0
  46. package/dist/parsers/altium/net-extractor.d.ts.map +1 -0
  47. package/dist/parsers/altium/net-extractor.js +295 -0
  48. package/dist/parsers/altium/net-extractor.js.map +1 -0
  49. package/dist/parsers/altium/ole-reader.d.ts +91 -0
  50. package/dist/parsers/altium/ole-reader.d.ts.map +1 -0
  51. package/dist/parsers/altium/ole-reader.js +304 -0
  52. package/dist/parsers/altium/ole-reader.js.map +1 -0
  53. package/dist/parsers/altium/record-parser.d.ts +21 -0
  54. package/dist/parsers/altium/record-parser.d.ts.map +1 -0
  55. package/dist/parsers/altium/record-parser.js +117 -0
  56. package/dist/parsers/altium/record-parser.js.map +1 -0
  57. package/dist/parsers/altium/schemas.d.ts +277 -0
  58. package/dist/parsers/altium/schemas.d.ts.map +1 -0
  59. package/dist/parsers/altium/schemas.js +246 -0
  60. package/dist/parsers/altium/schemas.js.map +1 -0
  61. package/dist/parsers/altium/types.d.ts +213 -0
  62. package/dist/parsers/altium/types.d.ts.map +1 -0
  63. package/dist/parsers/altium/types.js +180 -0
  64. package/dist/parsers/altium/types.js.map +1 -0
  65. package/dist/parsers/cadence/discovery.d.ts +45 -0
  66. package/dist/parsers/cadence/discovery.d.ts.map +1 -0
  67. package/dist/parsers/cadence/discovery.js +277 -0
  68. package/dist/parsers/cadence/discovery.js.map +1 -0
  69. package/dist/parsers/cadence/index.d.ts +41 -0
  70. package/dist/parsers/cadence/index.d.ts.map +1 -0
  71. package/dist/parsers/cadence/index.js +139 -0
  72. package/dist/parsers/cadence/index.js.map +1 -0
  73. package/dist/parsers/cadence/pstchip-parser.d.ts +23 -0
  74. package/dist/parsers/cadence/pstchip-parser.d.ts.map +1 -0
  75. package/dist/parsers/cadence/pstchip-parser.js +82 -0
  76. package/dist/parsers/cadence/pstchip-parser.js.map +1 -0
  77. package/dist/parsers/cadence/pstxnet-parser.d.ts +15 -0
  78. package/dist/parsers/cadence/pstxnet-parser.d.ts.map +1 -0
  79. package/dist/parsers/cadence/pstxnet-parser.js +55 -0
  80. package/dist/parsers/cadence/pstxnet-parser.js.map +1 -0
  81. package/dist/parsers/cadence/pstxprt-parser.d.ts +24 -0
  82. package/dist/parsers/cadence/pstxprt-parser.d.ts.map +1 -0
  83. package/dist/parsers/cadence/pstxprt-parser.js +75 -0
  84. package/dist/parsers/cadence/pstxprt-parser.js.map +1 -0
  85. package/dist/parsers/index.d.ts +33 -0
  86. package/dist/parsers/index.d.ts.map +1 -0
  87. package/dist/parsers/index.js +49 -0
  88. package/dist/parsers/index.js.map +1 -0
  89. package/dist/server.d.ts +16 -0
  90. package/dist/server.d.ts.map +1 -0
  91. package/dist/server.js +277 -0
  92. package/dist/server.js.map +1 -0
  93. package/dist/service.d.ts +129 -0
  94. package/dist/service.d.ts.map +1 -0
  95. package/dist/service.js +759 -0
  96. package/dist/service.js.map +1 -0
  97. package/dist/types.d.ts +242 -0
  98. package/dist/types.d.ts.map +1 -0
  99. package/dist/types.js +27 -0
  100. package/dist/types.js.map +1 -0
  101. package/dist/version.d.ts +10 -0
  102. package/dist/version.d.ts.map +1 -0
  103. package/dist/version.js +25 -0
  104. package/dist/version.js.map +1 -0
  105. package/package.json +74 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,121 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [0.0.12] - 2026-01-30
9
+
10
+ ### Fixed
11
+
12
+ - Fix `--version` for npm/npx installs (reads from package.json at runtime)
13
+
14
+ ## [0.0.11] - 2026-01-30
15
+
16
+ ### Fixed
17
+
18
+ - Fix release workflow to inject BUILD_VERSION when compiling binaries
19
+
20
+ ## [0.0.10] - 2026-01-30
21
+
22
+ ### Fixed
23
+
24
+ - Fix `--version` showing wrong version in compiled binaries (was hardcoded to 0.0.3, now injected at build time)
25
+ - Fix `--uninstall` to remove entire install directory instead of just the binary
26
+
27
+ ## [0.0.9] - 2026-01-30
28
+
29
+ ### Fixed
30
+
31
+ - Use `npm install` instead of `npm ci` for cross-platform compatibility with npm 11.x
32
+
33
+ ## [0.0.8] - 2026-01-29
34
+
35
+ ### Fixed
36
+
37
+ - Fix npm OIDC publishing by removing `registry-url` from setup-node (was creating auth token placeholder that interfered with OIDC)
38
+ - Explicitly upgrade npm to latest version for reliable OIDC support
39
+
40
+ ## [0.0.7] - 2026-01-29
41
+
42
+ ### Fixed
43
+
44
+ - Use Node.js 22 for npm publish (OIDC requires npm 11.5.1+)
45
+
46
+ ## [0.0.6] - 2026-01-29
47
+
48
+ ### Fixed
49
+
50
+ - Exclude test files from npm package (reduces package size)
51
+
52
+ ## [0.0.5] - 2026-01-29
53
+
54
+ ### Fixed
55
+
56
+ - Fix npm publish workflow failing due to rollup platform-specific dependency bug ([npm/cli#4828](https://github.com/npm/cli/issues/4828))
57
+ - Use `--ignore-scripts` during npm publish as a security best practice
58
+
59
+ ### Notes
60
+
61
+ - v0.0.4 GitHub release exists but npm publish failed; this release provides npm package availability
62
+
63
+ ## [0.0.4] - 2026-01-29
64
+
65
+ ### Added
66
+
67
+ - npm publishing support: install via `npm install -g universal-netlist` or use with `npx`
68
+ - Simpler MCP configuration for npm global installs
69
+
70
+ ### Changed
71
+
72
+ - `--update` command now provides npm-specific instructions for npm installs
73
+ - Skip auto-update for npm installs (use `npm update -g` instead)
74
+
75
+ ## [0.0.3] - 2026-01-29
76
+
77
+ ### Changed
78
+
79
+ - Release notes are now automatically extracted from CHANGELOG.md
80
+
81
+ ## [0.0.2] - 2026-01-29
82
+
83
+ ### Fixed
84
+
85
+ - Show helpful message when run directly in terminal instead of hanging
86
+
87
+ ## [0.0.1] - 2026-01-29
88
+
89
+ ### Added
90
+
91
+ - Initial open source release
92
+ - MCP server for querying EDA netlists
93
+ - Support for Cadence CIS (.dsn) and HDL (.cpm) formats
94
+ - Support for Altium Designer (.PrjPcb) projects
95
+ - Tools for listing and searching designs, components, and nets
96
+ - XNET traversal for tracing circuit connectivity
97
+ - Cadence netlist export (Windows only)
98
+
99
+ ### Tools
100
+
101
+ - `list_designs` - Discover design projects in a directory
102
+ - `list_components` - List components by type prefix
103
+ - `list_nets` - List all nets in a design
104
+ - `search_nets` - Search nets by regex pattern
105
+ - `search_components_by_refdes` - Search by reference designator
106
+ - `search_components_by_mpn` - Search by Manufacturer Part Number
107
+ - `search_components_by_description` - Search by description
108
+ - `query_component` - Get component details with pin mappings
109
+ - `query_xnet_by_net_name` - Trace connectivity from a net
110
+ - `query_xnet_by_pin_name` - Trace connectivity from a pin
111
+ - `export_cadence_netlist` - Export to Allegro format
112
+
113
+ [0.0.9]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.9
114
+ [0.0.8]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.8
115
+ [0.0.7]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.7
116
+ [0.0.6]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.6
117
+ [0.0.5]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.5
118
+ [0.0.4]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.4
119
+ [0.0.3]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.3
120
+ [0.0.2]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.2
121
+ [0.0.1]: https://github.com/IntelligentElectron/universal-netlist/releases/tag/v0.0.1
package/LICENSE ADDED
@@ -0,0 +1,190 @@
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 the 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
+ Copyright 2024-2025 Valentino Zegna
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,4 @@
1
+ Universal Netlist MCP Server
2
+ Copyright 2024-2025 Valentino Zegna
3
+
4
+ This product includes software developed by Valentino Zegna.
package/README.md ADDED
@@ -0,0 +1,246 @@
1
+ # Universal Netlist MCP Server
2
+
3
+ The **Universal Netlist MCP Server** gives AI agents the tools to understand and analyze your electrical schematics, for powerful and comprehensive design reviews through natural conversations.
4
+
5
+ It is compatible with Altium and Cadence, with plans to integrate more EDAs in the future. Note that you must already own a license of these EDAs to unleash the full capabilities of this MCP server.
6
+
7
+ ## Supported Formats
8
+
9
+ | Format | Extension | Description |
10
+ |--------|-----------|-------------|
11
+ | Cadence CIS | `.dsn` | Cadence Capture CIS schematic designs |
12
+ | Cadence HDL | `.cpm` | Cadence HDL schematic designs |
13
+ | Altium Designer | `.PrjPcb` | Altium Designer PCB projects |
14
+
15
+ ## Native Install (Recommended)
16
+
17
+ **macOS / Linux:**
18
+
19
+ ```bash
20
+ curl -fsSL https://raw.githubusercontent.com/IntelligentElectron/universal-netlist/main/install.sh | bash
21
+ ```
22
+
23
+ **Windows (PowerShell):**
24
+
25
+ ```powershell
26
+ irm https://raw.githubusercontent.com/IntelligentElectron/universal-netlist/main/install.ps1 | iex
27
+ ```
28
+
29
+ Why use the native installer:
30
+ - **No dependencies** — standalone binary, no Node.js required
31
+ - **Auto-updates** — checks for updates on startup
32
+ - **Signed binaries** — macOS binaries are notarized by Apple
33
+
34
+ The installer downloads two files:
35
+
36
+ 1. **Binary** - For CLI usage and manual MCP client configuration
37
+ 2. **Claude Desktop extension** (.mcpb) - For easy Claude Desktop integration
38
+
39
+ | Platform | Install Directory |
40
+ |----------|-------------------|
41
+ | macOS | `~/Library/Application Support/universal-netlist/` |
42
+ | Linux | `~/.local/share/universal-netlist/` |
43
+ | Windows | `%LOCALAPPDATA%\universal-netlist\` |
44
+
45
+ ### Update
46
+
47
+ The server checks for updates on startup. To update manually:
48
+
49
+ ```bash
50
+ universal-netlist --update
51
+ ```
52
+
53
+ ## Alternative: Install via npm
54
+
55
+ For developers who prefer npm:
56
+
57
+ ```bash
58
+ npm install -g universal-netlist
59
+ ```
60
+
61
+ Or use with npx (no installation required):
62
+
63
+ ```bash
64
+ npx universal-netlist --help
65
+ ```
66
+
67
+ Requires Node.js 20+.
68
+
69
+ To update:
70
+
71
+ ```bash
72
+ npm update -g universal-netlist
73
+ ```
74
+
75
+ ## Connect the MCP with your favorite AI tool
76
+
77
+ ### Claude Desktop (Recommended)
78
+
79
+ We recommend the [Claude Desktop app](https://claude.ai/download) for its simplicity, great features, and access to Anthropic's powerful Claude models.
80
+
81
+ 1. Install via [Native Installer](#native-install-recommended) method
82
+ 2. Open Claude Desktop and go to **Settings** (gear icon)
83
+ 3. Under **Desktop app**, click **Extensions**
84
+ 4. Click **Advanced settings**
85
+ 5. In the **Extension Developer** section, click **Install Extension...**
86
+ 6. Navigate to your install directory and select `universal-netlist.mcpb`:
87
+ - **macOS**: `~/Library/Application Support/universal-netlist/universal-netlist.mcpb`
88
+ - **Windows**: `%LOCALAPPDATA%\universal-netlist\universal-netlist.mcpb`
89
+
90
+ The extension will be available immediately in your conversations.
91
+
92
+ ### Other AI Tools
93
+
94
+ As an alternative, the Universal Netlist MCP Server can be connected to any MCP-compatible AI tool. Below are configuration examples for popular options.
95
+
96
+ <details>
97
+ <summary><strong>Claude Code</strong></summary>
98
+
99
+ **Using npm global install (simplest):**
100
+
101
+ ```bash
102
+ claude mcp add universal-netlist -- universal-netlist
103
+ ```
104
+
105
+ **Using standalone binary:**
106
+
107
+ macOS:
108
+
109
+ ```bash
110
+ claude mcp add universal-netlist -- ~/Library/Application\ Support/universal-netlist/bin/universal-netlist
111
+ ```
112
+
113
+ Linux:
114
+
115
+ ```bash
116
+ claude mcp add universal-netlist -- ~/.local/share/universal-netlist/bin/universal-netlist
117
+ ```
118
+
119
+ Windows:
120
+
121
+ ```cmd
122
+ claude mcp add universal-netlist -- %LOCALAPPDATA%\universal-netlist\bin\universal-netlist.exe
123
+ ```
124
+
125
+ </details>
126
+
127
+ <details>
128
+ <summary><strong>VS Code (GitHub Copilot)</strong></summary>
129
+
130
+ Add to `.vscode/mcp.json` in your project.
131
+
132
+ **macOS:**
133
+
134
+ ```json
135
+ {
136
+ "servers": {
137
+ "universal-netlist": {
138
+ "type": "stdio",
139
+ "command": "/Users/YOUR_USERNAME/Library/Application Support/universal-netlist/bin/universal-netlist"
140
+ }
141
+ }
142
+ }
143
+ ```
144
+
145
+ **Linux:**
146
+
147
+ ```json
148
+ {
149
+ "servers": {
150
+ "universal-netlist": {
151
+ "type": "stdio",
152
+ "command": "/home/YOUR_USERNAME/.local/share/universal-netlist/bin/universal-netlist"
153
+ }
154
+ }
155
+ }
156
+ ```
157
+
158
+ **Windows:**
159
+
160
+ ```json
161
+ {
162
+ "servers": {
163
+ "universal-netlist": {
164
+ "type": "stdio",
165
+ "command": "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\universal-netlist\\bin\\universal-netlist.exe"
166
+ }
167
+ }
168
+ }
169
+ ```
170
+
171
+ Then enable in **Configure Tools** (click the tools icon in Copilot chat).
172
+
173
+ </details>
174
+
175
+ <details>
176
+ <summary><strong>Gemini CLI</strong></summary>
177
+
178
+ Add to `~/.gemini/settings.json` (global) or `.gemini/settings.json` (project).
179
+
180
+ **macOS:**
181
+
182
+ ```json
183
+ {
184
+ "mcpServers": {
185
+ "universal-netlist": {
186
+ "command": "/Users/YOUR_USERNAME/Library/Application Support/universal-netlist/bin/universal-netlist"
187
+ }
188
+ }
189
+ }
190
+ ```
191
+
192
+ **Linux:**
193
+
194
+ ```json
195
+ {
196
+ "mcpServers": {
197
+ "universal-netlist": {
198
+ "command": "/home/YOUR_USERNAME/.local/share/universal-netlist/bin/universal-netlist"
199
+ }
200
+ }
201
+ }
202
+ ```
203
+
204
+ **Windows:**
205
+
206
+ ```json
207
+ {
208
+ "mcpServers": {
209
+ "universal-netlist": {
210
+ "command": "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\universal-netlist\\bin\\universal-netlist.exe"
211
+ }
212
+ }
213
+ }
214
+ ```
215
+
216
+ </details>
217
+
218
+ ## Supported Platforms
219
+
220
+ | Platform | Binary |
221
+ |----------|--------|
222
+ | macOS (Intel) | `universal-netlist-darwin-x64` |
223
+ | macOS (Apple Silicon) | `universal-netlist-darwin-arm64` |
224
+ | Linux (x64) | `universal-netlist-linux-x64` |
225
+ | Linux (ARM64) | `universal-netlist-linux-arm64` |
226
+ | Windows (x64) | `universal-netlist-windows-x64.exe` |
227
+
228
+ ## Documentation
229
+
230
+ See [docs/](docs/README.md) for API documentation and response schemas.
231
+
232
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
233
+
234
+ ---
235
+
236
+ ## About
237
+
238
+ Created by **Valentino Zegna**
239
+
240
+ This project is hosted on GitHub under the [IntelligentElectron](https://github.com/IntelligentElectron) organization.
241
+
242
+ Universal Netlist MCP Server and the universal netlist open standard are original works by Valentino Zegna.
243
+
244
+ ## License
245
+
246
+ Apache License 2.0 - see [LICENSE](LICENSE)
@@ -0,0 +1,73 @@
1
+ /**
2
+ * Circuit traversal utilities for netlist analysis
3
+ * Pure functions for identifying power/ground nets and passive components
4
+ */
5
+ import type { NetConnections, ComponentDetails, CircuitComponent } from "./types.js";
6
+ /**
7
+ * Check if a net name matches the ground pattern.
8
+ */
9
+ export declare const isGroundNet: (netName: string) => boolean;
10
+ /**
11
+ * Check if a net name matches the power pattern.
12
+ */
13
+ export declare const isPowerNet: (netName: string) => boolean;
14
+ /**
15
+ * Check if a net name matches the stop pattern (power or ground).
16
+ */
17
+ export declare const isStopNet: (netName: string) => boolean;
18
+ /**
19
+ * Determine if a component is a traversable passive (R/RS, L, C, FB).
20
+ */
21
+ export declare const isPassive: (refdes: string) => boolean;
22
+ /**
23
+ * Check if a string is a valid refdes (letters followed by alphanumerics).
24
+ * Filters out Cadence instance paths like "@DESIGN.SHEET:INS123@PART".
25
+ */
26
+ export declare const isValidRefdes: (refdes: string) => boolean;
27
+ /**
28
+ * Extract a refdes prefix (letters only).
29
+ */
30
+ export declare const getRefdesPrefix: (refdes: string) => string;
31
+ /**
32
+ * Check if a refdes matches a prefix filter.
33
+ */
34
+ export declare const matchesRefdesType: (refdes: string, type: string) => boolean;
35
+ /**
36
+ * Detect Do Not Stuff components using common markers.
37
+ */
38
+ export declare const isDnsComponent: (component?: {
39
+ mpn?: string | null;
40
+ description?: string;
41
+ comment?: string;
42
+ }) => boolean;
43
+ /**
44
+ * Generate a natural sort key for strings with numbers.
45
+ * Allows proper sorting like: U1, U2, U10 (instead of U1, U10, U2)
46
+ */
47
+ export declare const naturalSortKey: (s: string | number) => Array<string | number>;
48
+ /**
49
+ * Natural sort comparator function.
50
+ * Usage: array.sort(naturalSort)
51
+ */
52
+ export declare const naturalSort: (a: string, b: string) => number;
53
+ /**
54
+ * Compute a stable hash for a circuit.
55
+ * Components with the same XNET produce identical hashes regardless of query starting point.
56
+ */
57
+ export declare const computeCircuitHash: (components: CircuitComponent[]) => string;
58
+ export interface TraversalResult {
59
+ components: CircuitComponent[];
60
+ visited_nets: string[];
61
+ skipped: Record<string, number>;
62
+ }
63
+ export interface TraversalOptions {
64
+ skipTypes?: string[];
65
+ includeDns?: boolean;
66
+ }
67
+ /**
68
+ * Traverse circuit from a starting net, following passive components.
69
+ * Uses BFS to explore connections through R, L, C, FB components.
70
+ * Stops at active components and power/ground nets.
71
+ */
72
+ export declare const traverseCircuitFromNet: (startNet: string, nets: NetConnections, components: ComponentDetails, options?: TraversalOptions) => TraversalResult;
73
+ //# sourceMappingURL=circuit-traversal.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"circuit-traversal.d.ts","sourceRoot":"","sources":["../src/circuit-traversal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAWpB;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS,MAAM,KAAG,OACZ,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,UAAU,GAAI,SAAS,MAAM,KAAG,OACZ,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS,MAAM,KAAG,OACZ,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,MAAM,KAAG,OAU1C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,KAAG,OACZ,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,KAAG,MAGhD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,MAAM,MAAM,KAAG,OAIhE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,YAAY;IACzC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,KAAG,OAIH,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,GAAG,MAAM,GAAG,MAAM,KAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAOxE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,GAAG,MAAM,EAAE,GAAG,MAAM,KAAG,MAalD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,YAAY,gBAAgB,EAAE,KAAG,MAuBnE,CAAC;AAaF,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAgFD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GACjC,UAAU,MAAM,EAChB,MAAM,cAAc,EACpB,YAAY,gBAAgB,EAC5B,UAAS,gBAAqB,KAC7B,eAgJF,CAAC"}