@intelligentelectron/pcb-lens 0.0.10 → 1.0.0
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.
- package/CHANGELOG.md +35 -0
- package/README.md +42 -25
- package/dist/cli/commands.d.ts.map +1 -1
- package/dist/cli/commands.js +3 -2
- package/dist/cli/commands.js.map +1 -1
- package/dist/cli/executable.d.ts +20 -0
- package/dist/cli/executable.d.ts.map +1 -0
- package/dist/cli/executable.js +27 -0
- package/dist/cli/executable.js.map +1 -0
- package/dist/cli/updater.d.ts +0 -4
- package/dist/cli/updater.d.ts.map +1 -1
- package/dist/cli/updater.js +6 -13
- package/dist/cli/updater.js.map +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +19 -17
- package/dist/server.js.map +1 -1
- package/dist/service.d.ts +6 -6
- package/dist/service.d.ts.map +1 -1
- package/dist/service.js +5 -5
- package/dist/service.js.map +1 -1
- package/dist/telemetry/index.d.ts +12 -0
- package/dist/telemetry/index.d.ts.map +1 -0
- package/dist/telemetry/index.js +12 -0
- package/dist/telemetry/index.js.map +1 -0
- package/dist/{telemetry.d.ts → telemetry/local.d.ts} +1 -1
- package/dist/telemetry/local.d.ts.map +1 -0
- package/dist/{telemetry.js → telemetry/local.js} +6 -3
- package/dist/telemetry/local.js.map +1 -0
- package/dist/telemetry/otel.d.ts +43 -0
- package/dist/telemetry/otel.d.ts.map +1 -0
- package/dist/telemetry/otel.js +336 -0
- package/dist/telemetry/otel.js.map +1 -0
- package/dist/tools/export-cadence-constraints.js +1 -1
- package/dist/tools/export-cadence-constraints.js.map +1 -1
- package/dist/tools/{export-cadence-board.d.ts → export-cadence-ipc2581.d.ts} +1 -1
- package/dist/tools/export-cadence-ipc2581.d.ts.map +1 -0
- package/dist/tools/{export-cadence-board.js → export-cadence-ipc2581.js} +4 -4
- package/dist/tools/export-cadence-ipc2581.js.map +1 -0
- package/dist/tools/{query-constraints.d.ts → get-constraints.d.ts} +1 -1
- package/dist/tools/get-constraints.d.ts.map +1 -0
- package/dist/tools/{query-constraints.js → get-constraints.js} +4 -4
- package/dist/tools/get-constraints.js.map +1 -0
- package/dist/tools/get-pcb-component.d.ts +5 -0
- package/dist/tools/get-pcb-component.d.ts.map +1 -0
- package/dist/tools/get-pcb-component.js +224 -0
- package/dist/tools/get-pcb-component.js.map +1 -0
- package/dist/tools/{get-design-overview.d.ts → get-pcb-metadata.d.ts} +1 -1
- package/dist/tools/get-pcb-metadata.d.ts.map +1 -0
- package/dist/tools/{get-design-overview.js → get-pcb-metadata.js} +4 -4
- package/dist/tools/get-pcb-metadata.js.map +1 -0
- package/dist/tools/{query-net.d.ts → get-pcb-net.d.ts} +1 -1
- package/dist/tools/get-pcb-net.d.ts.map +1 -0
- package/dist/tools/{query-net.js → get-pcb-net.js} +70 -50
- package/dist/tools/get-pcb-net.js.map +1 -0
- package/dist/tools/lib/geometry.d.ts +38 -0
- package/dist/tools/lib/geometry.d.ts.map +1 -0
- package/dist/tools/lib/geometry.js +210 -0
- package/dist/tools/lib/geometry.js.map +1 -0
- package/dist/tools/lib/package-parser.d.ts +26 -0
- package/dist/tools/lib/package-parser.d.ts.map +1 -0
- package/dist/tools/lib/package-parser.js +59 -0
- package/dist/tools/lib/package-parser.js.map +1 -0
- package/dist/tools/lib/types.d.ts +59 -14
- package/dist/tools/lib/types.d.ts.map +1 -1
- package/dist/tools/render-net.d.ts.map +1 -1
- package/dist/tools/render-net.js +1 -199
- package/dist/tools/render-net.js.map +1 -1
- package/dist/tools/shared.d.ts +21 -0
- package/dist/tools/shared.d.ts.map +1 -1
- package/dist/tools/shared.js +29 -0
- package/dist/tools/shared.js.map +1 -1
- package/package.json +13 -1
- package/dist/telemetry.d.ts.map +0 -1
- package/dist/telemetry.js.map +0 -1
- package/dist/tools/export-cadence-board.d.ts.map +0 -1
- package/dist/tools/export-cadence-board.js.map +0 -1
- package/dist/tools/get-design-overview.d.ts.map +0 -1
- package/dist/tools/get-design-overview.js.map +0 -1
- package/dist/tools/query-components.d.ts +0 -5
- package/dist/tools/query-components.d.ts.map +0 -1
- package/dist/tools/query-components.js +0 -128
- package/dist/tools/query-components.js.map +0 -1
- package/dist/tools/query-constraints.d.ts.map +0 -1
- package/dist/tools/query-constraints.js.map +0 -1
- package/dist/tools/query-net.d.ts.map +0 -1
- package/dist/tools/query-net.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,41 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.0.0] - 2026-06-17
|
|
9
|
+
|
|
10
|
+
First stable release.
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- OpenTelemetry instrumentation: every tool call emits a span (`tool/<tool_name>`), metrics (`tool.calls`, `tool.duration`, `tool.errors`), and a structured log correlated by trace/span id, exported to any OTLP-compatible backend purely via the standard `OTEL_*` environment variables. Disabled and zero-overhead unless an OTLP endpoint is configured
|
|
15
|
+
- `enduser.id` resource attribute set from the host OS account name, attributing telemetry to the per-session user across traces, metrics, and logs
|
|
16
|
+
- Opt-in raw tool-argument capture on spans via `OTEL_CAPTURE_TOOL_ARGS=1` (off by default)
|
|
17
|
+
|
|
18
|
+
### Changed
|
|
19
|
+
|
|
20
|
+
- Consolidated telemetry into `src/telemetry/`: local JSONL usage analytics (`local`) and OpenTelemetry (`otel`) behind a single barrel
|
|
21
|
+
|
|
22
|
+
### Fixed
|
|
23
|
+
|
|
24
|
+
- Self-update now runs only for the compiled standalone binary; running from source (tsx/node) no longer performs a GitHub update check or re-execs into a downloaded binary
|
|
25
|
+
|
|
26
|
+
## [0.1.0] - 2026-03-13
|
|
27
|
+
|
|
28
|
+
### Added
|
|
29
|
+
|
|
30
|
+
- Per-pin pad geometry in `get_pcb_component` output (positions and shapes with deduplication)
|
|
31
|
+
- Net connectivity in `get_pcb_component` output (connected nets with pin names and total pin counts)
|
|
32
|
+
- Structured package parsing from Cadence footprint naming (packageFamily, pinCount, bodySize_mm, pitch_mm)
|
|
33
|
+
- Shared geometry extraction module (`lib/geometry.ts`) for pad, shape, and via utilities
|
|
34
|
+
|
|
35
|
+
### Changed
|
|
36
|
+
|
|
37
|
+
- Renamed `get_pcb_components` to `get_pcb_component`: single exact-refdes lookup instead of regex multi-match
|
|
38
|
+
- Switched pads to columnar format with deduplicated shapes (`padShapes[]` + `padRows[]` of `[pin, x, y, shapeIndex]`)
|
|
39
|
+
- Switched component nets to columnar format (`netColumns` + `netRows[]` of `[netName, pins, pinCount]`)
|
|
40
|
+
- Switched vias in `get_pcb_net` to columnar format with deduplicated drill types (`viaDrills[]` + `viaRows[]` of `[x, y, drillIndex]`)
|
|
41
|
+
- Rounded all micron coordinate and dimension values to integers
|
|
42
|
+
|
|
8
43
|
## [0.0.10] - 2026-03-03
|
|
9
44
|
|
|
10
45
|
### Changed
|
package/README.md
CHANGED
|
@@ -103,41 +103,58 @@ Install [OpenAI Codex](https://developers.openai.com/codex/cli/), then run:
|
|
|
103
103
|
codex mcp add pcb-lens -- pcb-lens
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
|
|
106
|
+
## Supported Platforms
|
|
107
107
|
|
|
108
|
-
|
|
108
|
+
| Platform | Binary |
|
|
109
|
+
|----------|--------|
|
|
110
|
+
| macOS (Universal) | `pcb-lens-darwin-universal` |
|
|
111
|
+
| Linux (x64) | `pcb-lens-linux-x64` |
|
|
112
|
+
| Linux (ARM64) | `pcb-lens-linux-arm64` |
|
|
113
|
+
| Windows (x64) | `pcb-lens-windows-x64.exe` |
|
|
109
114
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
115
|
+
## Observability (OpenTelemetry)
|
|
116
|
+
|
|
117
|
+
The server can emit [OpenTelemetry](https://opentelemetry.io/) **traces, metrics, and logs** for every tool call, so you can see which tools are used, how long they take, and what fails. It is vendor-neutral: it works with any OTLP-compatible backend (an OpenTelemetry Collector, Jaeger, Tempo, Prometheus, Honeycomb, Datadog, a managed cloud tracing service, etc.).
|
|
118
|
+
|
|
119
|
+
**Disabled by default.** Telemetry is a no-op with zero overhead unless you set an OTLP endpoint. Turn it on purely with the standard `OTEL_*` environment variables; no code changes and no bespoke config.
|
|
120
|
+
|
|
121
|
+
Each tool call emits:
|
|
122
|
+
|
|
123
|
+
- a span `tool/<tool_name>` with `tool.name`, `tool.outcome` (`success`/`error`), `tool.duration_ms`, and `error.type` on failure;
|
|
124
|
+
- metrics `tool.calls` (counter), `tool.duration` (ms histogram), and `tool.errors` (counter), labeled by `tool` and `outcome`;
|
|
125
|
+
- a structured log record carrying the active trace/span IDs for trace-to-log correlation.
|
|
113
126
|
|
|
114
|
-
|
|
127
|
+
All telemetry is tagged with `enduser.id`, the host OS account name of whoever is running the server, as a resource attribute (so it appears on traces, metrics, and logs). This attributes usage to the per-session user without any configuration.
|
|
115
128
|
|
|
116
|
-
|
|
129
|
+
### Quick start with a local Collector / Jaeger
|
|
117
130
|
|
|
118
|
-
|
|
131
|
+
Run an all-in-one Jaeger (which accepts OTLP and renders traces) and point the server at it:
|
|
119
132
|
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
}
|
|
127
|
-
}
|
|
128
|
-
}
|
|
133
|
+
```bash
|
|
134
|
+
docker run --rm -p 4318:4318 -p 16686:16686 jaegertracing/all-in-one:latest
|
|
135
|
+
|
|
136
|
+
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
|
|
137
|
+
export OTEL_SERVICE_NAME=pcb-lens
|
|
138
|
+
# then start the MCP server as usual; open http://localhost:16686 to view traces
|
|
129
139
|
```
|
|
130
140
|
|
|
131
|
-
|
|
141
|
+
### Configuration
|
|
132
142
|
|
|
133
|
-
|
|
143
|
+
Only standard OpenTelemetry environment variables are used:
|
|
134
144
|
|
|
135
|
-
|
|
|
136
|
-
|
|
137
|
-
|
|
|
138
|
-
|
|
|
139
|
-
|
|
|
140
|
-
|
|
|
145
|
+
| Variable | Purpose |
|
|
146
|
+
|----------|---------|
|
|
147
|
+
| `OTEL_EXPORTER_OTLP_ENDPOINT` | OTLP endpoint to export to. **Setting this enables telemetry.** |
|
|
148
|
+
| `OTEL_EXPORTER_OTLP_HEADERS` | Headers for the exporter, e.g. `Authorization=Bearer <token>` for a managed backend. |
|
|
149
|
+
| `OTEL_EXPORTER_OTLP_PROTOCOL` | `http/protobuf` (default) or `http/json`. `grpc` is not bundled in the standalone binaries and falls back to `http/protobuf`. |
|
|
150
|
+
| `OTEL_SERVICE_NAME`, `OTEL_RESOURCE_ATTRIBUTES` | Resource identity. |
|
|
151
|
+
| `OTEL_SDK_DISABLED`, `OTEL_TRACES_SAMPLER`, ... | Standard OTel SDK knobs. |
|
|
152
|
+
|
|
153
|
+
Additional, clearly-scoped options:
|
|
154
|
+
|
|
155
|
+
- `OTEL_CAPTURE_TOOL_ARGS=1`: also record raw tool arguments on the span (off by default; arguments may be sensitive).
|
|
156
|
+
|
|
157
|
+
Telemetry never affects tool results: exporter failures, misconfiguration, or an unreachable backend degrade to "no telemetry", and pending data is flushed on shutdown.
|
|
141
158
|
|
|
142
159
|
## Documentation
|
|
143
160
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA;;GAEG;
|
|
1
|
+
{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA;;GAEG;AAWH;;GAEG;AACH,eAAO,MAAM,YAAY,QAAO,IAE/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,QAAO,IAsB5B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,QAAa,OAAO,CAAC,IAAI,CAsCxD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,QAAa,OAAO,CAAC,IAAI,CAiC3D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,QAAa,OAAO,CAAC,IAAI,CAQjE,CAAC"}
|
package/dist/cli/commands.js
CHANGED
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
import { existsSync, rmSync } from "node:fs";
|
|
5
5
|
import { dirname } from "node:path";
|
|
6
6
|
import { VERSION, GITHUB_REPO, BINARY_NAME } from "./version.js";
|
|
7
|
-
import { exportTelemetry } from "../telemetry.js";
|
|
8
|
-
import { checkForUpdate, performUpdate, isNpmInstall
|
|
7
|
+
import { exportTelemetry } from "../telemetry/index.js";
|
|
8
|
+
import { checkForUpdate, performUpdate, isNpmInstall } from "./updater.js";
|
|
9
|
+
import { getCurrentExecutablePath } from "./executable.js";
|
|
9
10
|
import { confirm } from "./prompts.js";
|
|
10
11
|
import { removeFromPath } from "./shell.js";
|
|
11
12
|
/**
|
package/dist/cli/commands.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAS,EAAE;IACrC,OAAO,CAAC,GAAG,CAAC,GAAG,WAAW,KAAK,OAAO,EAAE,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,GAAS,EAAE;IAClC,OAAO,CAAC,GAAG,CACT;EACF,WAAW,KAAK,OAAO;;;;;IAKrB,WAAW;;;;;;;;;;;uBAWQ,WAAW;CACjC,CAAC,IAAI,EAAE,CACL,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,IAAmB,EAAE;IAC3D,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,MAAM,cAAc,EAAE,CAAC;IAErC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,+BAA+B,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QAC5D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,8BAA8B,OAAO,GAAG,CAAC,CAAC;QACtD,OAAO;IACT,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,qBAAqB,OAAO,OAAO,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC;IAEtE,IAAI,YAAY,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC/B,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;QAC7D,OAAO;IACT,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,aAAc,CAAC,CAAC;IAE5E,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,gBAAgB,MAAM,CAAC,eAAe,OAAO,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC9E,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,IAAmB,EAAE;IAC9D,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,oBAAoB,WAAW,8BAA8B,CAAC,CAAC;IAC/F,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACnC,OAAO;IACT,CAAC;IAED,MAAM,UAAU,GAAG,wBAAwB,EAAE,CAAC;IAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnC,0CAA0C;IAC1C,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IACxC,MAAM,aAAa,GAAG,cAAc,EAAE,CAAC;IACvC,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,CAAC,GAAG,CAAC,aAAa,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,2BAA2B;IAC3B,OAAO,CAAC,GAAG,CAAC,+BAA+B,UAAU,EAAE,CAAC,CAAC;IACzD,IAAI,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CACX,+BAA+B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAChF,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,GAAG,WAAW,wBAAwB,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,KAAK,IAAmB,EAAE;IACpE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,eAAe,EAAE,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACtE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared helpers for locating the running CLI executable.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Get the path to the current executable.
|
|
6
|
+
*
|
|
7
|
+
* For Bun-compiled binaries, `process.execPath` points to the binary itself.
|
|
8
|
+
* For Node.js, `process.argv[1]` is the script path.
|
|
9
|
+
*/
|
|
10
|
+
export declare const getCurrentExecutablePath: () => string;
|
|
11
|
+
/**
|
|
12
|
+
* Whether the process is running as a Bun-compiled standalone binary.
|
|
13
|
+
*
|
|
14
|
+
* Running from source via the `node`/`bun`/`tsx` interpreter leaves
|
|
15
|
+
* `process.execPath` pointing at that interpreter; a compiled binary's
|
|
16
|
+
* `execPath` is the binary itself. Only the compiled binary should ever
|
|
17
|
+
* self-update.
|
|
18
|
+
*/
|
|
19
|
+
export declare const isCompiledBinary: () => boolean;
|
|
20
|
+
//# sourceMappingURL=executable.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"executable.d.ts","sourceRoot":"","sources":["../../src/cli/executable.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,QAAO,MAO3C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,QAAO,OACqC,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared helpers for locating the running CLI executable.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Get the path to the current executable.
|
|
6
|
+
*
|
|
7
|
+
* For Bun-compiled binaries, `process.execPath` points to the binary itself.
|
|
8
|
+
* For Node.js, `process.argv[1]` is the script path.
|
|
9
|
+
*/
|
|
10
|
+
export const getCurrentExecutablePath = () => {
|
|
11
|
+
if (process.execPath.includes("node") || process.execPath.includes("bun")) {
|
|
12
|
+
// Running via node/bun interpreter - use argv[1]
|
|
13
|
+
return process.argv[1];
|
|
14
|
+
}
|
|
15
|
+
// Compiled binary - use execPath
|
|
16
|
+
return process.execPath;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Whether the process is running as a Bun-compiled standalone binary.
|
|
20
|
+
*
|
|
21
|
+
* Running from source via the `node`/`bun`/`tsx` interpreter leaves
|
|
22
|
+
* `process.execPath` pointing at that interpreter; a compiled binary's
|
|
23
|
+
* `execPath` is the binary itself. Only the compiled binary should ever
|
|
24
|
+
* self-update.
|
|
25
|
+
*/
|
|
26
|
+
export const isCompiledBinary = () => !process.execPath.includes("node") && !process.execPath.includes("bun");
|
|
27
|
+
//# sourceMappingURL=executable.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"executable.js","sourceRoot":"","sources":["../../src/cli/executable.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAW,EAAE;IACnD,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1E,iDAAiD;QACjD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;IACD,iCAAiC;IACjC,OAAO,OAAO,CAAC,QAAQ,CAAC;AAC1B,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAY,EAAE,CAC5C,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC"}
|
package/dist/cli/updater.d.ts
CHANGED
|
@@ -27,10 +27,6 @@ export declare const isNpmInstall: () => boolean;
|
|
|
27
27
|
* Check if an update is available.
|
|
28
28
|
*/
|
|
29
29
|
export declare const checkForUpdate: () => Promise<UpdateCheckResult>;
|
|
30
|
-
/**
|
|
31
|
-
* Get the path to the current executable.
|
|
32
|
-
*/
|
|
33
|
-
export declare const getCurrentExecutablePath: () => string;
|
|
34
30
|
/**
|
|
35
31
|
* Perform the update by downloading and replacing the current binary.
|
|
36
32
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updater.d.ts","sourceRoot":"","sources":["../../src/cli/updater.ts"],"names":[],"mappings":"AAAA;;;;GAIG;
|
|
1
|
+
{"version":3,"file":"updater.d.ts","sourceRoot":"","sources":["../../src/cli/updater.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAyBH,iCAAiC;AACjC,MAAM,WAAW,iBAAiB;IAChC,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qCAAqC;AACrC,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,QAAO,OAG/B,CAAC;AAwEF;;GAEG;AACH,eAAO,MAAM,cAAc,QAAa,OAAO,CAAC,iBAAiB,CA8BhE,CAAC;AAiEF;;GAEG;AACH,eAAO,MAAM,aAAa,GACxB,aAAa,MAAM,EACnB,YAAY,MAAM,KACjB,OAAO,CAAC,YAAY,CAmEtB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM,QAAO,KAuBzB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAa,OAAO,CAAC,OAAO,CAmClD,CAAC"}
|
package/dist/cli/updater.js
CHANGED
|
@@ -8,6 +8,7 @@ import { tmpdir } from "node:os";
|
|
|
8
8
|
import { join, dirname, basename } from "node:path";
|
|
9
9
|
import { spawn } from "node:child_process";
|
|
10
10
|
import { VERSION, GITHUB_REPO, BINARY_NAME } from "./version.js";
|
|
11
|
+
import { getCurrentExecutablePath, isCompiledBinary } from "./executable.js";
|
|
11
12
|
/**
|
|
12
13
|
* Detect if running as an npm global install or via npx.
|
|
13
14
|
* npm installs run from node_modules, not as compiled binaries.
|
|
@@ -138,19 +139,6 @@ const downloadFile = async (url, destPath) => {
|
|
|
138
139
|
nodeStream.on("error", reject);
|
|
139
140
|
});
|
|
140
141
|
};
|
|
141
|
-
/**
|
|
142
|
-
* Get the path to the current executable.
|
|
143
|
-
*/
|
|
144
|
-
export const getCurrentExecutablePath = () => {
|
|
145
|
-
// For Bun-compiled binaries, process.execPath points to the binary itself
|
|
146
|
-
// For Node.js, process.argv[1] is the script path
|
|
147
|
-
if (process.execPath.includes("node") || process.execPath.includes("bun")) {
|
|
148
|
-
// Running via node/bun interpreter - use argv[1]
|
|
149
|
-
return process.argv[1];
|
|
150
|
-
}
|
|
151
|
-
// Compiled binary - use execPath
|
|
152
|
-
return process.execPath;
|
|
153
|
-
};
|
|
154
142
|
/**
|
|
155
143
|
* Generate a unique backup path with timestamp to avoid conflicts with locked files.
|
|
156
144
|
* On Windows, previous backup files may still be locked by the old process.
|
|
@@ -279,6 +267,11 @@ export const reexec = () => {
|
|
|
279
267
|
* @returns true if an update was applied and process should restart
|
|
280
268
|
*/
|
|
281
269
|
export const autoUpdate = async () => {
|
|
270
|
+
// Only the compiled standalone binary self-updates. Running from source
|
|
271
|
+
// (tsx/node) must never download a binary and re-exec into it.
|
|
272
|
+
if (!isCompiledBinary()) {
|
|
273
|
+
return false;
|
|
274
|
+
}
|
|
282
275
|
// Skip auto-update for npm installs - use npm update instead
|
|
283
276
|
if (isNpmInstall()) {
|
|
284
277
|
return false;
|
package/dist/cli/updater.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updater.js","sourceRoot":"","sources":["../../src/cli/updater.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,iBAAiB,EACjB,SAAS,EACT,UAAU,EACV,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"updater.js","sourceRoot":"","sources":["../../src/cli/updater.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,iBAAiB,EACjB,SAAS,EACT,UAAU,EACV,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AA4B7E;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAY,EAAE;IACxC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnC,OAAO,UAAU,EAAE,QAAQ,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC;AACvD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG,GAAW,EAAE;IACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1B,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,GAAG,WAAW,mBAAmB,CAAC;IAC3C,CAAC;SAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;QAChC,OAAO,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,cAAc,CAAC,CAAC,CAAC,GAAG,WAAW,YAAY,CAAC;IACtF,CAAC;SAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;QAChC,OAAO,GAAG,WAAW,kBAAkB,CAAC;IAC1C,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,YAAY,GAAG,CAAC,OAAe,EAAY,EAAE;IACjD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC1C,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,eAAe,GAAG,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE;IACvD,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAEtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,kBAAkB,GAAG,KAAK,IAA4B,EAAE;IAC5D,MAAM,GAAG,GAAG,gCAAgC,WAAW,kBAAkB,CAAC;IAC1E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,OAAO,EAAE;YACP,MAAM,EAAE,gCAAgC;YACxC,YAAY,EAAE,GAAG,WAAW,IAAI,OAAO,EAAE;SAC1C;QACD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;KACpC,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,EAA4B,CAAC;AACnD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,IAAgC,EAAE;IACnE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAC3C,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACzD,MAAM,eAAe,GAAG,eAAe,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpE,IAAI,WAAW,GAAkB,IAAI,CAAC;QACtC,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,UAAU,GAAG,qBAAqB,EAAE,CAAC;YAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;YAChE,IAAI,KAAK,EAAE,CAAC;gBACV,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,OAAO;YACL,eAAe;YACf,cAAc,EAAE,OAAO;YACvB,aAAa;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,OAAO;YACvB,aAAa,EAAE,IAAI;YACnB,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;SAC9D,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,YAAY,GAAG,KAAK,EAAE,GAAW,EAAE,QAAgB,EAAiB,EAAE;IAC1E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,OAAO,EAAE;YACP,YAAY,EAAE,GAAG,WAAW,IAAI,OAAO,EAAE;SAC1C;QACD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;KACpC,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,oBAAoB,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;IACjD,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAE/C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5B,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC/B,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,aAAa,GAAG,CAAC,WAAmB,EAAU,EAAE;IACpD,OAAO,GAAG,WAAW,WAAW,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;AAC/C,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,iBAAiB,GAAG,CAAC,WAAmB,EAAQ,EAAE;IACtD,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnC,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC;oBACH,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC9B,CAAC;gBAAC,MAAM,CAAC;oBACP,oCAAoC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,+BAA+B;IACjC,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,WAAmB,EACnB,UAAkB,EACK,EAAE;IACzB,MAAM,WAAW,GAAG,wBAAwB,EAAE,CAAC;IAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,WAAW,WAAW,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACvE,oFAAoF;IACpF,MAAM,UAAU,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;IAE9C,sEAAsE;IACtE,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAE/B,IAAI,CAAC;QACH,uCAAuC;QACvC,MAAM,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAE1C,kBAAkB;QAClB,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YACjC,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC;QAED,wBAAwB;QACxB,IAAI,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5B,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACtC,CAAC;QAED,6BAA6B;QAC7B,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAElC,2DAA2D;QAC3D,IAAI,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC;gBACH,UAAU,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC;YAAC,MAAM,CAAC;gBACP,sDAAsD;gBACtD,uDAAuD;YACzD,CAAC;QACH,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI;YACb,eAAe,EAAE,OAAO;YACxB,UAAU;SACX,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,4BAA4B;QAC5B,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC;gBACH,UAAU,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;YACtC,CAAC;YAAC,MAAM,CAAC;gBACP,wBAAwB;YAC1B,CAAC;QACH,CAAC;QAED,qBAAqB;QACrB,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC;gBACH,UAAU,CAAC,QAAQ,CAAC,CAAC;YACvB,CAAC;YAAC,MAAM,CAAC;gBACP,wBAAwB;YAC1B,CAAC;QACH,CAAC;QAED,OAAO;YACL,OAAO,EAAE,KAAK;YACd,eAAe,EAAE,OAAO;YACxB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;SAC9D,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,GAAU,EAAE;IAChC,MAAM,QAAQ,GAAG,wBAAwB,EAAE,CAAC;IAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEnC,wBAAwB;IACxB,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE;QAClC,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;IAEH,qCAAqC;IACrC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QACxB,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;QACxB,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QACjD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,yDAAyD;IACzD,mDAAmD;IACnD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,IAAsB,EAAE;IACrD,wEAAwE;IACxE,+DAA+D;IAC/D,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6DAA6D;IAC7D,IAAI,YAAY,EAAE,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,cAAc,EAAE,CAAC;IAErC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,0CAA0C;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;QACzE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IAC/D,OAAO,CAAC,KAAK,CAAC,4BAA4B,OAAO,OAAO,KAAK,CAAC,aAAa,KAAK,CAAC,CAAC;IAElF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE3E,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,6BAA6B,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC3D,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}
|
package/dist/server.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAkDpE;;GAEG;AACH,eAAO,MAAM,YAAY,QAAO,SAuB/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,QAAa,OAAO,CAAC,IAAI,
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAkDpE;;GAEG;AACH,eAAO,MAAM,YAAY,QAAO,SAuB/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,QAAa,OAAO,CAAC,IAAI,CAO9C,CAAC"}
|
package/dist/server.js
CHANGED
|
@@ -8,13 +8,13 @@ import crypto from "node:crypto";
|
|
|
8
8
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
9
9
|
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
10
10
|
import { VERSION } from "./cli/version.js";
|
|
11
|
-
import { initTelemetry } from "./telemetry.js";
|
|
12
|
-
import { register as
|
|
13
|
-
import { register as
|
|
14
|
-
import { register as
|
|
15
|
-
import { register as
|
|
11
|
+
import { initTelemetry, initOtel } from "./telemetry/index.js";
|
|
12
|
+
import { register as registerGetPcbMetadata } from "./tools/get-pcb-metadata.js";
|
|
13
|
+
import { register as registerGetPcbComponent } from "./tools/get-pcb-component.js";
|
|
14
|
+
import { register as registerGetPcbNet } from "./tools/get-pcb-net.js";
|
|
15
|
+
import { register as registerExportCadenceIpc2581 } from "./tools/export-cadence-ipc2581.js";
|
|
16
16
|
import { register as registerExportCadenceConstraints } from "./tools/export-cadence-constraints.js";
|
|
17
|
-
import { register as
|
|
17
|
+
import { register as registerGetConstraints } from "./tools/get-constraints.js";
|
|
18
18
|
// =============================================================================
|
|
19
19
|
// Server Instructions
|
|
20
20
|
// =============================================================================
|
|
@@ -26,17 +26,17 @@ Supports IPC-2581 XML files (RevA, RevB, RevC) exported from any compliant EDA t
|
|
|
26
26
|
|
|
27
27
|
## Workflow Guidance
|
|
28
28
|
|
|
29
|
-
1. If starting from a Cadence Allegro .brd file, use \`
|
|
30
|
-
2. To access design constraints (trace width rules, spacing rules, net classes, stackup), use \`export_cadence_constraints\` to generate a .tcfx file, then \`
|
|
31
|
-
3. Use \`
|
|
32
|
-
4. Use \`
|
|
33
|
-
5. Use \`
|
|
29
|
+
1. If starting from a Cadence Allegro .brd file, use \`export_cadence_ipc2581\` to generate the IPC-2581 XML first (Windows only)
|
|
30
|
+
2. To access design constraints (trace width rules, spacing rules, net classes, stackup), use \`export_cadence_constraints\` to generate a .tcfx file, then \`get_constraints\` to read it
|
|
31
|
+
3. Use \`get_pcb_metadata\` first to understand the design structure, layer stackup, and size
|
|
32
|
+
4. Use \`get_pcb_component\` to look up a single component by exact refdes
|
|
33
|
+
5. Use \`get_pcb_net\` to trace a net's routing, trace widths, vias, and connected pins
|
|
34
34
|
6. Use \`render_net\` to visualize a net's routing geometry as SVG
|
|
35
35
|
|
|
36
36
|
## Tool Usage Tips
|
|
37
37
|
|
|
38
38
|
- All query/render tools accept an IPC-2581 XML file path as the first argument
|
|
39
|
-
- Component refdes
|
|
39
|
+
- Component refdes is an exact match (e.g., "U5", "C10", "R22")
|
|
40
40
|
- Net name patterns use regex (e.g., "DDR_D0", "^VCC", "CLK")
|
|
41
41
|
- All physical values (coordinates, trace widths) are normalized to microns regardless of the source file's native unit
|
|
42
42
|
- Rotation is in degrees counterclockwise
|
|
@@ -64,12 +64,12 @@ export const createServer = () => {
|
|
|
64
64
|
},
|
|
65
65
|
instructions: SERVER_INSTRUCTIONS,
|
|
66
66
|
});
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
67
|
+
registerGetPcbMetadata(server);
|
|
68
|
+
registerGetPcbComponent(server);
|
|
69
|
+
registerGetPcbNet(server);
|
|
70
|
+
registerExportCadenceIpc2581(server);
|
|
71
71
|
registerExportCadenceConstraints(server);
|
|
72
|
-
|
|
72
|
+
registerGetConstraints(server);
|
|
73
73
|
// TODO: register render-net once PNG output via resvg-wasm is stable in compiled binaries
|
|
74
74
|
return server;
|
|
75
75
|
};
|
|
@@ -78,6 +78,8 @@ export const createServer = () => {
|
|
|
78
78
|
*/
|
|
79
79
|
export const runServer = async () => {
|
|
80
80
|
initTelemetry(crypto.randomUUID());
|
|
81
|
+
// Opt-in OpenTelemetry (no-op unless OTEL_* env is configured).
|
|
82
|
+
await initOtel({ serviceName: "pcb-lens", serviceVersion: VERSION });
|
|
81
83
|
const server = createServer();
|
|
82
84
|
const transport = new StdioServerTransport();
|
|
83
85
|
await server.connect(transport);
|
package/dist/server.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,QAAQ,IAAI,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACjF,OAAO,EAAE,QAAQ,IAAI,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACnF,OAAO,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,QAAQ,IAAI,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAC7F,OAAO,EAAE,QAAQ,IAAI,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AACrG,OAAO,EAAE,QAAQ,IAAI,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEhF,gFAAgF;AAChF,sBAAsB;AACtB,gFAAgF;AAEhF,MAAM,mBAAmB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6B3B,CAAC,IAAI,EAAE,CAAC;AAET,gFAAgF;AAChF,eAAe;AACf,gFAAgF;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAc,EAAE;IAC1C,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B;QACE,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,OAAO;KACjB,EACD;QACE,YAAY,EAAE;YACZ,KAAK,EAAE,EAAE;SACV;QACD,YAAY,EAAE,mBAAmB;KAClC,CACF,CAAC;IAEF,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC/B,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAChC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC1B,4BAA4B,CAAC,MAAM,CAAC,CAAC;IACrC,gCAAgC,CAAC,MAAM,CAAC,CAAC;IACzC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC/B,0FAA0F;IAE1F,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,IAAmB,EAAE;IACjD,aAAa,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IACnC,gEAAgE;IAChE,MAAM,QAAQ,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC;IACrE,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAClC,CAAC,CAAC"}
|
package/dist/service.d.ts
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
* Public API for IPC-2581 PCB layout analysis.
|
|
5
5
|
* All tool logic is exposed as standalone async functions for programmatic use.
|
|
6
6
|
*/
|
|
7
|
-
export { getDesignOverview } from "./tools/get-
|
|
8
|
-
export {
|
|
9
|
-
export { queryNet } from "./tools/
|
|
10
|
-
export { exportCadenceBoard } from "./tools/export-cadence-
|
|
7
|
+
export { getDesignOverview } from "./tools/get-pcb-metadata.js";
|
|
8
|
+
export { queryComponent } from "./tools/get-pcb-component.js";
|
|
9
|
+
export { queryNet } from "./tools/get-pcb-net.js";
|
|
10
|
+
export { exportCadenceBoard } from "./tools/export-cadence-ipc2581.js";
|
|
11
11
|
export { exportCadenceConstraints } from "./tools/export-cadence-constraints.js";
|
|
12
|
-
export { queryConstraints } from "./tools/
|
|
13
|
-
export type { ErrorResult, DesignOverview, LayerInfo, SectionInfo, ComponentInfo, ComponentResult,
|
|
12
|
+
export { queryConstraints } from "./tools/get-constraints.js";
|
|
13
|
+
export type { ErrorResult, DesignOverview, LayerInfo, SectionInfo, ComponentInfo, ComponentResult, NetPin, NetRouteInfo, ViaDrill, ViaRow, QueryNetResult, QueryNetsResult, CadenceInstall, ExportCadenceBoardResult, ExportCadenceConstraintsResult, ConstraintObject, CrossSection, CrossSectionLayer, ConstraintsOverviewResult, ConstraintsSectionResult, } from "./tools/lib/types.js";
|
|
14
14
|
export { isErrorResult } from "./tools/lib/types.js";
|
|
15
15
|
//# sourceMappingURL=service.d.ts.map
|
package/dist/service.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAG9D,YAAY,EACV,WAAW,EACX,cAAc,EACd,SAAS,EACT,WAAW,EACX,aAAa,EACb,eAAe,EACf,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,cAAc,EACd,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,8BAA8B,EAC9B,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC"}
|
package/dist/service.js
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
* Public API for IPC-2581 PCB layout analysis.
|
|
5
5
|
* All tool logic is exposed as standalone async functions for programmatic use.
|
|
6
6
|
*/
|
|
7
|
-
export { getDesignOverview } from "./tools/get-
|
|
8
|
-
export {
|
|
9
|
-
export { queryNet } from "./tools/
|
|
10
|
-
export { exportCadenceBoard } from "./tools/export-cadence-
|
|
7
|
+
export { getDesignOverview } from "./tools/get-pcb-metadata.js";
|
|
8
|
+
export { queryComponent } from "./tools/get-pcb-component.js";
|
|
9
|
+
export { queryNet } from "./tools/get-pcb-net.js";
|
|
10
|
+
export { exportCadenceBoard } from "./tools/export-cadence-ipc2581.js";
|
|
11
11
|
export { exportCadenceConstraints } from "./tools/export-cadence-constraints.js";
|
|
12
|
-
export { queryConstraints } from "./tools/
|
|
12
|
+
export { queryConstraints } from "./tools/get-constraints.js";
|
|
13
13
|
export { isErrorResult } from "./tools/lib/types.js";
|
|
14
14
|
//# sourceMappingURL=service.js.map
|
package/dist/service.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AA0B9D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Telemetry public API.
|
|
3
|
+
*
|
|
4
|
+
* - `local`: fire-and-forget JSONL usage analytics written next to the install.
|
|
5
|
+
* - `otel`: opt-in OpenTelemetry traces/metrics/logs (no-op unless OTEL_* env
|
|
6
|
+
* is configured).
|
|
7
|
+
*
|
|
8
|
+
* Import telemetry from this barrel rather than the individual modules.
|
|
9
|
+
*/
|
|
10
|
+
export * from "./local.js";
|
|
11
|
+
export * from "./otel.js";
|
|
12
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/telemetry/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Telemetry public API.
|
|
3
|
+
*
|
|
4
|
+
* - `local`: fire-and-forget JSONL usage analytics written next to the install.
|
|
5
|
+
* - `otel`: opt-in OpenTelemetry traces/metrics/logs (no-op unless OTEL_* env
|
|
6
|
+
* is configured).
|
|
7
|
+
*
|
|
8
|
+
* Import telemetry from this barrel rather than the individual modules.
|
|
9
|
+
*/
|
|
10
|
+
export * from "./local.js";
|
|
11
|
+
export * from "./otel.js";
|
|
12
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/telemetry/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"local.d.ts","sourceRoot":"","sources":["../../src/telemetry/local.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;CAClB;AASD;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAO,MAkBhC,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAAO,MAKnC,CAAC;AAmBF;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,IAAI,MAAM,KAAG,IAY1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;CAClB,KAAG,IAUH,CAAC;AAMF,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,EAChE,UAAU,MAAM,EAChB,SAAS,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,KACzB,WAAW,CAAC,CAAC,EAAE,CAAC,CA8BlB,CAAC;AAMF;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAa,OAAO,CAAC,MAAM,CAwBtD,CAAC"}
|
|
@@ -8,7 +8,8 @@ import { appendFileSync, mkdirSync, existsSync, statSync } from "node:fs";
|
|
|
8
8
|
import { dirname, join } from "node:path";
|
|
9
9
|
import { userInfo, hostname, platform, arch, release } from "node:os";
|
|
10
10
|
import { execSync } from "node:child_process";
|
|
11
|
-
import { VERSION } from "
|
|
11
|
+
import { VERSION } from "../cli/version.js";
|
|
12
|
+
import { instrumentTool } from "./otel.js";
|
|
12
13
|
// =============================================================================
|
|
13
14
|
// Install directory resolution
|
|
14
15
|
// =============================================================================
|
|
@@ -90,7 +91,9 @@ export const withTelemetry = (toolName, handler) => {
|
|
|
90
91
|
const start = Date.now();
|
|
91
92
|
let success = true;
|
|
92
93
|
try {
|
|
93
|
-
|
|
94
|
+
// OpenTelemetry span/metrics/logs wrap the handler (no-op unless configured
|
|
95
|
+
// via OTEL_* env). The handler runs exactly once, inside the span.
|
|
96
|
+
const result = await instrumentTool(toolName, args, () => handler(args), { isErrorResult: isErrorContent });
|
|
94
97
|
// Detect error results (objects with an "error" field in the text content)
|
|
95
98
|
if (isErrorContent(result)) {
|
|
96
99
|
success = false;
|
|
@@ -181,4 +184,4 @@ const isErrorContent = (result) => {
|
|
|
181
184
|
return false;
|
|
182
185
|
}
|
|
183
186
|
};
|
|
184
|
-
//# sourceMappingURL=
|
|
187
|
+
//# sourceMappingURL=local.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"local.js","sourceRoot":"","sources":["../../src/telemetry/local.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AA4B3C,gFAAgF;AAChF,+BAA+B;AAC/B,gFAAgF;AAEhF,MAAM,gBAAgB,GAAG,GAAY,EAAE,CACrC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,GAAW,EAAE;IACxC,IAAI,gBAAgB,EAAE,EAAE,CAAC;QACvB,wCAAwC;QACxC,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,qDAAqD;IACrD,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QACzB,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC,OAAO,EAAE,sCAAsC,CAAC,CAAC;QAC9F,KAAK,OAAO;YACV,OAAO,IAAI,CACT,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,EACrE,UAAU,CACX,CAAC;QACJ;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;IACjF,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAW,EAAE;IAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,CAAC;QACxC,OAAO,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;IAC7C,CAAC;IACD,OAAO,IAAI,CAAC,aAAa,EAAE,EAAE,iBAAiB,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,gFAAgF;AAChF,qBAAqB;AACrB,gFAAgF;AAEhF,IAAI,SAA6B,CAAC;AAElC,MAAM,WAAW,GAAG;IAClB,QAAQ,EAAE,QAAQ,EAAE;IACpB,IAAI,EAAE,IAAI,EAAE;IACZ,UAAU,EAAE,OAAO,EAAE;IACrB,QAAQ,EAAE,QAAQ,EAAE;CACrB,CAAC;AAEF,gFAAgF;AAChF,iBAAiB;AACjB,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAU,EAAQ,EAAE;IAChD,SAAS,GAAG,EAAE,CAAC;IAEf,MAAM,KAAK,GAAiB;QAC1B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,OAAO;QAChB,QAAQ,EAAE,WAAW,EAAE;QACvB,OAAO,EAAE,WAAW;KACrB,CAAC;IAEF,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAK5B,EAAQ,EAAE;IACT,IAAI,CAAC,SAAS;QAAE,OAAO;IAEvB,MAAM,KAAK,GAAc;QACvB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,UAAU,EAAE,SAAS;QACrB,GAAG,OAAO;KACX,CAAC;IAEF,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AACpC,CAAC,CAAC;AAQF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,QAAgB,EAChB,OAA0B,EACP,EAAE;IACrB,OAAO,KAAK,EAAE,IAAO,EAAc,EAAE;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC;YACH,4EAA4E;YAC5E,mEAAmE;YACnE,MAAM,MAAM,GAAG,MAAM,cAAc,CACjC,QAAQ,EACR,IAA+B,EAC/B,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EACnB,EAAE,aAAa,EAAE,cAAc,EAAE,CAClC,CAAC;YACF,2EAA2E;YAC3E,IAAI,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3B,OAAO,GAAG,KAAK,CAAC;YAClB,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,GAAG,KAAK,CAAC;YAChB,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,IAA+B;gBACrC,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK;gBAC/B,OAAO;aACR,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,IAAqB,EAAE;IACzD,MAAM,aAAa,GAAG,gBAAgB,EAAE,CAAC;IAEzC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,8BAA8B,aAAa,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IACtC,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC;IAClF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;IAE7C,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QACjC,QAAQ,CAAC,eAAe,OAAO,SAAS,OAAO,CAAC,aAAa,CAAC,mBAAmB,EAAE;YACjF,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,QAAQ,CAAC,WAAW,OAAO,MAAM,aAAa,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,gFAAgF;AAChF,mBAAmB;AACnB,gFAAgF;AAEhF,IAAI,UAAU,GAAG,KAAK,CAAC;AAEvB,MAAM,UAAU,GAAG,CAAC,IAAY,EAAQ,EAAE;IACxC,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,gBAAgB,EAAE,CAAC;QACpC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAClD,UAAU,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,cAAc,CAAC,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC,CAAC;IACxC,CAAC;IAAC,MAAM,CAAC;QACP,6BAA6B;IAC/B,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,GAAW,EAAE;IAC/B,IAAI,CAAC;QACH,OAAO,QAAQ,EAAE,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,cAAc,GAAG,CAAC,MAAe,EAAW,EAAE;IAClD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAChE,MAAM,CAAC,GAAG,MAAgD,CAAC;IAC3D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACtE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QACnD,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,IAAI,MAAM,CAAC;IAC5E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenTelemetry instrumentation (vendor-neutral, OTLP).
|
|
3
|
+
*
|
|
4
|
+
* Emits a span, metrics, and a structured log per tool call. Configured purely
|
|
5
|
+
* through the standard `OTEL_*` environment variables, so it works against any
|
|
6
|
+
* OTLP-compatible backend (Collector, Jaeger, Tempo, Honeycomb, Datadog, ...).
|
|
7
|
+
*
|
|
8
|
+
* Design constraints (see issue #66):
|
|
9
|
+
* - Disabled by default. If no OTLP endpoint is configured the SDK is never
|
|
10
|
+
* imported and `instrumentTool` is a pass-through with zero overhead.
|
|
11
|
+
* - Telemetry must never break a tool call. Every span/metric/log operation is
|
|
12
|
+
* wrapped so an exporter or SDK fault degrades to "no telemetry", never an
|
|
13
|
+
* error returned to the caller.
|
|
14
|
+
* - This module is shared verbatim across the MCP servers. Repo-specific values
|
|
15
|
+
* (service name) are passed into `initOtel`; everything else comes from env.
|
|
16
|
+
* - stdio transport owns stdout, so diagnostics are written to stderr only and
|
|
17
|
+
* no console/stdout exporter is ever used.
|
|
18
|
+
*/
|
|
19
|
+
/**
|
|
20
|
+
* Initialize OpenTelemetry if (and only if) the standard env vars request it.
|
|
21
|
+
* No-op and zero overhead otherwise. Safe to call exactly once at startup;
|
|
22
|
+
* never throws; a setup failure degrades to disabled telemetry.
|
|
23
|
+
*/
|
|
24
|
+
export declare const initOtel: (opts: {
|
|
25
|
+
serviceName: string;
|
|
26
|
+
serviceVersion: string;
|
|
27
|
+
}) => Promise<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Flush and shut down the SDK. Important for short-lived / CLI invocations so
|
|
30
|
+
* batched, async exports are not lost on exit. Idempotent and never throws.
|
|
31
|
+
*/
|
|
32
|
+
export declare const shutdownOtel: () => Promise<void>;
|
|
33
|
+
/**
|
|
34
|
+
* Wrap a single tool invocation in a span named `tool/<name>`, record the
|
|
35
|
+
* standard metrics, and emit a structured log correlated by trace/span id.
|
|
36
|
+
*
|
|
37
|
+
* `run` is executed exactly once. When telemetry is disabled this is a direct
|
|
38
|
+
* pass-through. Telemetry never alters the result and never throws on its own.
|
|
39
|
+
*/
|
|
40
|
+
export declare const instrumentTool: <R>(toolName: string, args: Record<string, unknown>, run: () => Promise<R>, opts?: {
|
|
41
|
+
isErrorResult?: (result: R) => boolean;
|
|
42
|
+
}) => Promise<R>;
|
|
43
|
+
//# sourceMappingURL=otel.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"otel.d.ts","sourceRoot":"","sources":["../../src/telemetry/otel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAqEH;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAU,MAAM;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CACxB,KAAG,OAAO,CAAC,IAAI,CA2Df,CAAC;AA0EF;;;GAGG;AACH,eAAO,MAAM,YAAY,QAAa,OAAO,CAAC,IAAI,CAejD,CAAC;AAMF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAU,CAAC,EACpC,UAAU,MAAM,EAChB,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,KAAK,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,OAAO;IAAE,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,CAAA;CAAE,KAChD,OAAO,CAAC,CAAC,CAiCX,CAAC"}
|