@nestrix-js/mcp 0.0.0-stage → 0.1.0-alpha.3

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,107 @@
-# Temporary Holding Version
+# @nestrix-js/mcp
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An [MCP](https://modelcontextprotocol.io) server that lets an AI assistant (Claude Code, Claude Desktop, Cursor and others) read what your NestJS app is doing through [Nestrix](https://github.com/nestrix-js/nestrix): requests as traces, errors, per-route and per-class statistics, and what the app calls. It is a small program the assistant starts over stdio. It talks HTTP to Nestrix and runs nothing inside your app.
+
+> **Status: alpha.** Needs Node 26.13 or later.
+
+## What it can do
+
+| Tool | What it is for |
+|---|---|
+| `overview` | Start here: the app, sampling, store size, the slowest and most failing routes, the stored error count. |
+| `find_traces` | List stored traces with filters (route, method, status, minimum duration, text, type, release, user, service). |
+| `get_trace` | One trace written for a model: repeated statements (a likely N+1) first, then errors with the first three stack frames, slow spans, and an indented span tree with self times. Capped at about 400 spans. |
+| `list_errors` | Recent errors grouped by type and message, with trace ids. |
+| `route_stats` | Request count, error rate and p50/p95/p99 per route over 15 or 60 minutes. |
+| `class_stats` | Per-class calls, errors and own time (needs `NestrixInstrument` in the app). |
+| `app_map` | What the app talks to: databases, caches, queues, outbound HTTP. |
+| `explain_slowness` | For one route: its percentiles, then where the time goes in its 5 slowest stored traces, by span name and class, with repeated statements. |
+| `start_profile` | Takes a CPU profile of the running app and returns the hottest functions. Embedded dashboards only. See [the warning](#start_profile-pauses-the-app). |
+
+Everything except `start_profile` only reads.
+
+## Two targets
+
+`NESTRIX_URL` is either of:
+
+- **An app's embedded dashboard**, for example `http://localhost:3000/_nestrix` (the dashboard's path, including a global prefix if you set one). `NESTRIX_TOKEN` is the app's `ui.auth.token`. The app must run the dashboard with a token:
+
+  ```ts
+  NestrixModule.forRoot({
+    ui: { enabled: true, auth: { token: process.env.NESTRIX_UI_TOKEN } }, // 32 characters or more
+  });
+  ```
+
+  The default `ui: 'auto'` is not enough: its startup token is a browser cookie flow and cannot be used by a tool. The dashboard answers `404` to a wrong token (so that it does not reveal itself), and this server reports that as "not a Nestrix dashboard or server, or wrong token".
+
+- **The Nestrix server** (`@nestrix-js/server`), for example `http://nestrix-server:4318`. `NESTRIX_TOKEN` is a server API token: read-only and revocable, created in the server's settings.
+
+| Variable | |
+|---|---|
+| `NESTRIX_URL` | Required. Base URL of the dashboard or server. A trailing slash is ignored. |
+| `NESTRIX_TOKEN` | Required. Sent as `Authorization: Bearer <token>`, never in a URL and never logged. |
+| `NESTRIX_TIMEOUT_MS` | Optional. Per-request timeout, 100 to 120000, default 10000. |
+
+Use `https://` for anything that is not on your own machine: the token otherwise travels unencrypted (the program warns on stderr).
+
+## Client configuration
+
+**Claude Code**
+
+```bash
+claude mcp add nestrix \
+  --env NESTRIX_URL=http://localhost:3000/_nestrix \
+  --env NESTRIX_TOKEN="$NESTRIX_UI_TOKEN" \
+  -- npx -y @nestrix-js/mcp@alpha
+```
+
+**Claude Desktop** (`claude_desktop_config.json`) and **Cursor** (`.cursor/mcp.json`)
+
+```json
+{
+  "mcpServers": {
+    "nestrix": {
+      "command": "npx",
+      "args": ["-y", "@nestrix-js/mcp@alpha"],
+      "env": {
+        "NESTRIX_URL": "http://localhost:3000/_nestrix",
+        "NESTRIX_TOKEN": "the app's ui.auth.token"
+      }
+    }
+  }
+}
+```
+
+Keep the token out of files you commit: most clients can read it from your environment instead of a literal value.
+
+## What the assistant can and cannot see
+
+It sees exactly what the dashboard shows, which is already scrubbed and redacted inside your app (the `redact` hook and the privacy defaults apply): span names, timings, the allow-listed attributes, SQL statement text without bind values, error messages and stack traces. Request and response bodies, bind parameters and headers outside the allowlist are never stored, so they cannot be read. Traces are sampled and kept in memory, so a rare or old request may be missing; `route_stats` counts every request.
+
+Text a tool returns is telemetry from your application: a span name or an error message can contain anything. The server tells the model to treat it as data, but give the assistant only the access you would give a colleague reading the dashboard.
+
+A server API token can read the query API and nothing else: it is refused by the UI, token management, alert and SLO writes, and ingest.
+
+## `start_profile` pauses the app
+
+`start_profile` is the only tool that changes anything: it starts a CPU capture in the running app and waits for it to end (default 15 seconds, at most 60), then returns the top functions by self time.
+
+- **Starting a capture pauses the whole app briefly**: about 10 ms per MB of compiled code, tens of milliseconds in a small app, a few hundred in a large one. Requests arriving meanwhile wait. Do not run it against production without the owner's agreement.
+- One capture runs at a time (a second start is answered with "already running"), and a new one cannot start within 10 seconds of the last.
+- Generate the traffic you want profiled while it runs; an idle app returns an empty profile.
+- It works only on an embedded dashboard whose profiler is available (see `overview`). The Nestrix server has no profiler, and the tool says so.
+- It sends what the endpoint requires from a trusted caller: a JSON body, an `Origin` equal to `NESTRIX_URL`'s origin and `Sec-Fetch-Site: same-origin`, along with the token.
+- A long duration can exceed the tool timeout of your client.
+
+## Errors you may see
+
+| Message | Meaning |
+|---|---|
+| `NESTRIX_URL is not set` / `NESTRIX_TOKEN is not set` | The environment of the MCP entry is incomplete. The program exits with this on stderr. |
+| `Nestrix refused the request (HTTP 401)` or `403` | Check `NESTRIX_TOKEN`. |
+| `NESTRIX_URL is not a Nestrix dashboard or server` | `GET api/v1/meta` answered 404: wrong base path, or an embedded dashboard rejecting the token. |
+| `Could not reach ...` / `No answer from ...` | The app or server is not running at that URL, or is too slow (`NESTRIX_TIMEOUT_MS`). |
+
+## Licence
+
+Apache-2.0.

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { ConfigError, isLoopbackUrl, loadConfig } from "./config.js";
+import { createMcpServer } from "./tools.js";
+/** Reads the environment, serves MCP over stdio. stdout carries the protocol, so messages go to stderr. */
+async function main() {
+    let config;
+    try {
+        config = loadConfig(process.env);
+    }
+    catch (error) {
+        if (error instanceof ConfigError) {
+            process.stderr.write(`nestrix-mcp: ${error.message}\n`);
+            process.exit(1);
+        }
+        throw error;
+    }
+    if (config.url.startsWith("http://") && !isLoopbackUrl(config.url)) {
+        process.stderr.write("nestrix-mcp: warning: NESTRIX_URL is plain http to a non-local host, so NESTRIX_TOKEN travels unencrypted.\n");
+    }
+    await createMcpServer(config).connect(new StdioServerTransport());
+}
+// Only when run as the program, not when a file is loaded with require() or import (the
+// no-top-level-await check loads every built file).
+if (import.meta.main) {
+    main().catch((error) => {
+        process.stderr.write(`nestrix-mcp: ${error instanceof Error ? error.message : String(error)}\n`);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,2GAA2G;AAC3G,KAAK,UAAU,IAAI;IACjB,IAAI,MAAqC,CAAC;IAC1C,IAAI,CAAC;QACH,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;YACxD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IACD,IAAI,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;QACnE,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,8GAA8G,CAC/G,CAAC;IACJ,CAAC;IACD,MAAM,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;AACpE,CAAC;AAED,wFAAwF;AACxF,oDAAoD;AACpD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACrB,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QAC9B,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,gBAAgB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAC3E,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,41 @@
+import type { AppMapResponse, ClassStatsResponse, ErrorListResponse, MetaResponse, ProfileDetail, ProfileListResponse, ProfileStartResponse, RouteStatsResponse, TraceListResponse, TraceResponse } from "@nestrix-js/protocol";
+import type { McpConfig } from "./config.js";
+/**
+ * A failed call to the query API. `message` is written for the model that will read it (and for
+ * the person behind it): it says what to check and never contains the token.
+ */
+export declare class NestrixError extends Error {
+    /** HTTP status; 0 when no response arrived. */
+    readonly status: number;
+    /** The parsed JSON body, when the answer had one. */
+    readonly body?: unknown | undefined;
+    name: string;
+    constructor(message: string, 
+    /** HTTP status; 0 when no response arrived. */
+    status: number, 
+    /** The parsed JSON body, when the answer had one. */
+    body?: unknown | undefined);
+}
+export type QueryValue = string | number | undefined;
+/** The part of the query API the tools use, over HTTP with `fetch`. */
+export declare class NestrixClient {
+    #private;
+    constructor(config: McpConfig, fetchImpl?: typeof fetch);
+    meta(): Promise<MetaResponse>;
+    traces(params: Record<string, QueryValue>): Promise<TraceListResponse>;
+    trace(id: string): Promise<TraceResponse>;
+    errors(params: Record<string, QueryValue>): Promise<ErrorListResponse>;
+    routes(params: Record<string, QueryValue>): Promise<RouteStatsResponse>;
+    classes(params: Record<string, QueryValue>): Promise<ClassStatsResponse>;
+    map(params: Record<string, QueryValue>): Promise<AppMapResponse>;
+    profiles(): Promise<ProfileListResponse>;
+    profile(id: string): Promise<ProfileDetail>;
+    /**
+     * Starts a capture. The endpoint accepts only what the dashboard page itself sends: a JSON body,
+     * an `Origin` equal to the request's own origin and `Sec-Fetch-Site: same-origin`. This client
+     * is the trusted caller (it holds the token), so it sets them.
+     */
+    startProfile(durationSeconds: number): Promise<ProfileStartResponse>;
+}
+/** `error.message` of an `ApiError` body, if it has one. */
+export declare function apiMessage(body: unknown): string | undefined;

package/dist/client.js

@@ -0,0 +1,172 @@
+/**
+ * A failed call to the query API. `message` is written for the model that will read it (and for
+ * the person behind it): it says what to check and never contains the token.
+ */
+export class NestrixError extends Error {
+    status;
+    body;
+    name = "NestrixError";
+    constructor(message, 
+    /** HTTP status; 0 when no response arrived. */
+    status, 
+    /** The parsed JSON body, when the answer had one. */
+    body) {
+        super(message);
+        this.status = status;
+        this.body = body;
+    }
+}
+/** The part of the query API the tools use, over HTTP with `fetch`. */
+export class NestrixClient {
+    #base;
+    #origin;
+    #token;
+    #timeoutMs;
+    #fetch;
+    constructor(config, fetchImpl = fetch) {
+        this.#base = config.url;
+        this.#origin = new URL(config.url).origin;
+        this.#token = config.token;
+        this.#timeoutMs = config.timeoutMs;
+        this.#fetch = fetchImpl;
+    }
+    meta() {
+        return this.#get("api/v1/meta", {});
+    }
+    traces(params) {
+        return this.#get("api/v1/traces", params);
+    }
+    trace(id) {
+        return this.#get("api/v1/trace", { id });
+    }
+    errors(params) {
+        return this.#get("api/v1/errors", params);
+    }
+    routes(params) {
+        return this.#get("api/v1/routes", params);
+    }
+    classes(params) {
+        return this.#get("api/v1/classes", params);
+    }
+    map(params) {
+        return this.#get("api/v1/map", params);
+    }
+    profiles() {
+        return this.#get("api/v1/profiles", {});
+    }
+    profile(id) {
+        return this.#get(`api/v1/profiles/${encodeURIComponent(id)}`, {});
+    }
+    /**
+     * Starts a capture. The endpoint accepts only what the dashboard page itself sends: a JSON body,
+     * an `Origin` equal to the request's own origin and `Sec-Fetch-Site: same-origin`. This client
+     * is the trusted caller (it holds the token), so it sets them.
+     */
+    async startProfile(durationSeconds) {
+        try {
+            return await this.#startProfile(durationSeconds);
+        }
+        catch (error) {
+            if (error instanceof NestrixError && error.status === 403) {
+                const said = apiMessage(error.body);
+                throw new NestrixError(`${said ? `The app said: ${said}. ` : ""}The app refused to start the capture (HTTP 403). If NESTRIX_TOKEN is right, the cause is usually the request origin: a reverse proxy in front of the app must pass the original Host header, because the endpoint accepts only requests whose Origin equals their own Host.`, 403, error.body);
+            }
+            throw error;
+        }
+    }
+    #startProfile(durationSeconds) {
+        return this.#request("api/v1/profiles", {}, {
+            method: "POST",
+            headers: {
+                "content-type": "application/json",
+                origin: this.#origin,
+                "sec-fetch-site": "same-origin",
+            },
+            body: JSON.stringify({ durationSeconds }),
+        });
+    }
+    #get(path, params) {
+        return this.#request(path, params, { method: "GET" });
+    }
+    async #request(path, params, init) {
+        const url = new URL(`${this.#base}/${path}`);
+        for (const [key, value] of Object.entries(params)) {
+            if (value !== undefined && value !== "") {
+                url.searchParams.set(key, String(value));
+            }
+        }
+        let response;
+        let text;
+        try {
+            response = await this.#fetch(url, {
+                ...init,
+                headers: {
+                    accept: "application/json",
+                    ...init.headers,
+                    authorization: `Bearer ${this.#token}`,
+                },
+                redirect: "manual",
+                signal: AbortSignal.timeout(this.#timeoutMs),
+            });
+            text = await response.text();
+        }
+        catch (error) {
+            throw this.#networkError(error);
+        }
+        let body;
+        try {
+            body = text === "" ? undefined : JSON.parse(text);
+        }
+        catch {
+            body = undefined;
+        }
+        if (response.ok) {
+            if (body === undefined || body === null || typeof body !== "object") {
+                throw new NestrixError(`${this.#base}/${path} answered HTTP ${response.status} but not with JSON: NESTRIX_URL does not look like a Nestrix dashboard or server.`, response.status);
+            }
+            return body;
+        }
+        throw this.#statusError(path, response.status, body);
+    }
+    #networkError(error) {
+        const name = error?.name;
+        if (name === "TimeoutError" || name === "AbortError") {
+            return new NestrixError(`No answer from ${this.#origin} within ${this.#timeoutMs} ms. Is the app running and NESTRIX_URL right? (NESTRIX_TIMEOUT_MS raises the limit.)`, 0);
+        }
+        // Never use `error.message`: undici can echo request headers (the token) in it.
+        const cause = error?.cause;
+        const code = error?.code;
+        const raw = typeof cause?.code === "string"
+            ? cause.code
+            : typeof code === "string"
+                ? code
+                : "";
+        const why = /^[A-Z0-9_]{1,40}$/.test(raw) ? raw : "network error";
+        return new NestrixError(`Could not reach ${this.#origin} (${why}). Is the app or server running, and is NESTRIX_URL right?`, 0);
+    }
+    #statusError(path, status, body) {
+        const detail = apiMessage(body);
+        const suffix = detail ? ` The server said: ${detail}` : "";
+        if (status === 401 || status === 403) {
+            return new NestrixError(`Nestrix refused the request (HTTP ${status}). Check NESTRIX_TOKEN: for an embedded dashboard it must equal the app's ui.auth.token, for the Nestrix server it must be a valid, unrevoked API token.${suffix}`, status, body);
+        }
+        if (status === 404 && path === "api/v1/meta") {
+            return new NestrixError("NESTRIX_URL is not a Nestrix dashboard or server: GET api/v1/meta answered 404. Use the dashboard's base path (for example http://localhost:3000/_nestrix) or the server's base URL. An embedded dashboard also answers 404 to a wrong NESTRIX_TOKEN, so check the token too, and that the app runs with `ui: { enabled: true, auth: { token } }`.", 404, body);
+        }
+        if (status === 404) {
+            return new NestrixError(`Not found: ${path}.${suffix || " This Nestrix version may not support it."}`, 404, body);
+        }
+        return new NestrixError(`Nestrix answered HTTP ${status} for ${path}.${suffix}`, status, body);
+    }
+}
+/** `error.message` of an `ApiError` body, if it has one. */
+export function apiMessage(body) {
+    if (body === null || typeof body !== "object")
+        return undefined;
+    const error = body.error;
+    if (error === null || typeof error !== "object")
+        return undefined;
+    const message = error.message;
+    return typeof message === "string" ? message : undefined;
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAcA;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IAK1B;IAEA;IANF,IAAI,GAAG,cAAc,CAAC;IAC/B,YACE,OAAe;IACf,+CAA+C;IACtC,MAAc;IACvB,qDAAqD;IAC5C,IAAc;QAEvB,KAAK,CAAC,OAAO,CAAC,CAAC;QAJN,WAAM,GAAN,MAAM,CAAQ;QAEd,SAAI,GAAJ,IAAI,CAAU;IAGzB,CAAC;CACF;AAID,uEAAuE;AACvE,MAAM,OAAO,aAAa;IACf,KAAK,CAAS;IACd,OAAO,CAAS;IAChB,MAAM,CAAS;IACf,UAAU,CAAS;IACnB,MAAM,CAAe;IAE9B,YAAY,MAAiB,EAAE,YAA0B,KAAK;QAC5D,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,CAAC,MAAkC;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IACD,KAAK,CAAC,EAAU;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,CAAC,MAAkC;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,CAAC,MAAkC;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,CAAC,MAAkC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IACD,GAAG,CAAC,MAAkC;QACpC,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IACD,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,eAAuB;QACxC,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1D,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACpC,MAAM,IAAI,YAAY,CACpB,GAAG,IAAI,CAAC,CAAC,CAAC,iBAAiB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,6QAA6Q,EACrT,GAAG,EACH,KAAK,CAAC,IAAI,CACX,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,aAAa,CAAC,eAAuB;QACnC,OAAO,IAAI,CAAC,QAAQ,CAClB,iBAAiB,EACjB,EAAE,EACF;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,IAAI,CAAC,OAAO;gBACpB,gBAAgB,EAAE,aAAa;aAChC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;SAC1C,CACF,CAAC;IACJ,CAAC;IAED,IAAI,CAAI,IAAY,EAAE,MAAkC;QACtD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,IAAY,EACZ,MAAkC,EAClC,IAAyE;QAEzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC;QAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBACxC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QACD,IAAI,QAAkB,CAAC;QACvB,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBAChC,GAAG,IAAI;gBACP,OAAO,EAAE;oBACP,MAAM,EAAE,kBAAkB;oBAC1B,GAAG,IAAI,CAAC,OAAO;oBACf,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;iBACvC;gBACD,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;aAC7C,CAAC,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,GAAG,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YAChB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACpE,MAAM,IAAI,YAAY,CACpB,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,kBAAkB,QAAQ,CAAC,MAAM,mFAAmF,EACzI,QAAQ,CAAC,MAAM,CAChB,CAAC;YACJ,CAAC;YACD,OAAO,IAAS,CAAC;QACnB,CAAC;QACD,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,aAAa,CAAC,KAAc;QAC1B,MAAM,IAAI,GAAI,KAA4B,EAAE,IAAI,CAAC;QACjD,IAAI,IAAI,KAAK,cAAc,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YACrD,OAAO,IAAI,YAAY,CACrB,kBAAkB,IAAI,CAAC,OAAO,WAAW,IAAI,CAAC,UAAU,uFAAuF,EAC/I,CAAC,CACF,CAAC;QACJ,CAAC;QACD,gFAAgF;QAChF,MAAM,KAAK,GAAI,KAA+C,EAAE,KAAK,CAAC;QACtE,MAAM,IAAI,GAAI,KAAmC,EAAE,IAAI,CAAC;QACxD,MAAM,GAAG,GACP,OAAO,KAAK,EAAE,IAAI,KAAK,QAAQ;YAC7B,CAAC,CAAC,KAAK,CAAC,IAAI;YACZ,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ;gBACxB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,GAAG,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC;QAClE,OAAO,IAAI,YAAY,CACrB,mBAAmB,IAAI,CAAC,OAAO,KAAK,GAAG,4DAA4D,EACnG,CAAC,CACF,CAAC;IACJ,CAAC;IAED,YAAY,CAAC,IAAY,EAAE,MAAc,EAAE,IAAa;QACtD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,qBAAqB,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACrC,OAAO,IAAI,YAAY,CACrB,qCAAqC,MAAM,2JAA2J,MAAM,EAAE,EAC9M,MAAM,EACN,IAAI,CACL,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,KAAK,GAAG,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;YAC7C,OAAO,IAAI,YAAY,CACrB,oVAAoV,EACpV,GAAG,EACH,IAAI,CACL,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,YAAY,CACrB,cAAc,IAAI,IAAI,MAAM,IAAI,2CAA2C,EAAE,EAC7E,GAAG,EACH,IAAI,CACL,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,YAAY,CACrB,yBAAyB,MAAM,QAAQ,IAAI,IAAI,MAAM,EAAE,EACvD,MAAM,EACN,IAAI,CACL,CAAC;IACJ,CAAC;CACF;AAED,4DAA4D;AAC5D,MAAM,UAAU,UAAU,CAAC,IAAa;IACtC,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAChE,MAAM,KAAK,GAAI,IAA4B,CAAC,KAAK,CAAC;IAClD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAClE,MAAM,OAAO,GAAI,KAA+B,CAAC,OAAO,CAAC;IACzD,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3D,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,16 @@
+/** Configuration of the MCP server, read from environment variables. */
+export interface McpConfig {
+    /** Base URL of the dashboard (`http://localhost:3000/_nestrix`) or the standalone server, without a trailing slash. */
+    url: string;
+    token: string;
+    /** Per-request timeout in milliseconds. */
+    timeoutMs: number;
+}
+/** A configuration problem, with a message meant to be shown to the person who set the variables. */
+export declare class ConfigError extends Error {
+    name: string;
+}
+/** Reads `NESTRIX_URL`, `NESTRIX_TOKEN` and `NESTRIX_TIMEOUT_MS`. Throws `ConfigError`. */
+export declare function loadConfig(env: Readonly<Record<string, string | undefined>>): McpConfig;
+/** True for `localhost`, `127.x.y.z` and `[::1]`. */
+export declare function isLoopbackUrl(url: string): boolean;

package/dist/config.js

@@ -0,0 +1,58 @@
+/** A configuration problem, with a message meant to be shown to the person who set the variables. */
+export class ConfigError extends Error {
+    name = "ConfigError";
+}
+const DEFAULT_TIMEOUT_MS = 10_000;
+/** Reads `NESTRIX_URL`, `NESTRIX_TOKEN` and `NESTRIX_TIMEOUT_MS`. Throws `ConfigError`. */
+export function loadConfig(env) {
+    const rawUrl = env.NESTRIX_URL?.trim();
+    if (!rawUrl) {
+        throw new ConfigError("NESTRIX_URL is not set. Set it to the base URL of the Nestrix dashboard (for example http://localhost:3000/_nestrix) or of the Nestrix server (for example http://localhost:4318).");
+    }
+    let parsed;
+    try {
+        parsed = new URL(rawUrl);
+    }
+    catch {
+        throw new ConfigError(`NESTRIX_URL is not a valid URL: ${rawUrl}`);
+    }
+    if (parsed.protocol !== "http:" && parsed.protocol !== "https:") {
+        throw new ConfigError("NESTRIX_URL must start with http:// or https://.");
+    }
+    if (parsed.username !== "" || parsed.password !== "") {
+        throw new ConfigError("NESTRIX_URL must not contain a user name or password. Put the token in NESTRIX_TOKEN.");
+    }
+    parsed.search = "";
+    parsed.hash = "";
+    const url = parsed.toString().replace(/\/+$/, "");
+    const token = env.NESTRIX_TOKEN?.trim();
+    if (!token) {
+        throw new ConfigError("NESTRIX_TOKEN is not set. For an app's embedded dashboard use the app's `ui.auth.token` (the app must run with `ui: { enabled: true, auth: { token } }`); for the Nestrix server use an API token created in its settings.");
+    }
+    if (!/^[\x21-\x7e]+$/.test(token)) {
+        throw new ConfigError("NESTRIX_TOKEN contains whitespace, control or non-ASCII characters, so it cannot be sent as an HTTP header. Check it for a stray newline or a bad copy-paste (the value is not shown).");
+    }
+    let timeoutMs = DEFAULT_TIMEOUT_MS;
+    const rawTimeout = env.NESTRIX_TIMEOUT_MS?.trim();
+    if (rawTimeout) {
+        const n = Number(rawTimeout);
+        if (!Number.isInteger(n) || n < 100 || n > 120_000) {
+            throw new ConfigError("NESTRIX_TIMEOUT_MS must be a whole number of milliseconds between 100 and 120000.");
+        }
+        timeoutMs = n;
+    }
+    return { url, token, timeoutMs };
+}
+/** True for `localhost`, `127.x.y.z` and `[::1]`. */
+export function isLoopbackUrl(url) {
+    try {
+        const host = new URL(url).hostname;
+        return (host === "localhost" ||
+            host === "[::1]" ||
+            /^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.test(host));
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=config.js.map