@mongodb-js/mcp-setup 3.0.0-prerelease.1

package/dist/setupTelemetry.js

@@ -0,0 +1,205 @@
+import { randomUUID } from "crypto";
+import { ApiClient, userAgentFromServerMetadata } from "@mongodb-js/mcp-atlas-api-client";
+import { getDefaultHttpClient } from "@mongodb-js/mcp-fetch";
+import { NoopLogger } from "@mongodb-js/mcp-core";
+import { DeviceId } from "@mongodb-js/mcp-tools-mongodb";
+import { AtlasTelemetry } from "@mongodb-js/mcp-atlas-telemetry";
+export const toBoolSet = (value) => {
+    if (value === undefined) {
+        return undefined;
+    }
+    return value ? "true" : "false";
+};
+/**
+ * Per-run helper that owns the setup telemetry session: assigns the
+ * `setup_session_id`, tracks wall-clock durations, and
+ * accumulates context so every event carries the full set of known flags.
+ *
+ * One instance is constructed per `runSetup` invocation. Callers emit typed
+ * events at each logical step and call {@link flush} before the process
+ * exits so buffered events are best-effort sent.
+ */
+export class SetupTelemetry {
+    /**
+     * Builds a fully-wired {@link SetupTelemetry} for the setup CLI: a silent
+     * logger (so telemetry's internal logging doesn't leak into the
+     * interactive wizard), a fresh {@link DeviceId}, an unauthenticated
+     * {@link ApiClient}, and an {@link AtlasTelemetry} instance.
+     */
+    static create({ config, keychain, serverMetadata, }) {
+        const logger = new NoopLogger();
+        const deviceId = DeviceId.create(logger);
+        // Shared, memoized proxy-aware fetch (see @mongodb-js/mcp-fetch).
+        const httpClient = getDefaultHttpClient();
+        const apiClient = new ApiClient({
+            baseUrl: config.apiBaseUrl,
+            userAgent: userAgentFromServerMetadata(serverMetadata),
+            httpClient,
+        }, logger);
+        const telemetry = AtlasTelemetry.create({
+            logger,
+            deviceId,
+            apiClient,
+            keychain,
+            enabled: config.telemetry === "enabled",
+            serverMetadata,
+        });
+        return new SetupTelemetry({ telemetry, deviceId });
+    }
+    /**
+     * Direct construction is primarily for tests that want to inject a mock
+     * telemetry pipeline. Production code should use {@link SetupTelemetry.create}.
+     */
+    constructor({ telemetry, deviceId }) {
+        this.setupSessionId = randomUUID();
+        this.startedAt = Date.now();
+        this.stepStartedAt = this.startedAt;
+        this.context = {};
+        this.telemetry = telemetry;
+        this.deviceId = deviceId;
+    }
+    /**
+     * Merges new context values into the accumulated context. Subsequent
+     * events will automatically carry the updated values.
+     */
+    updateContext(patch) {
+        this.context = { ...this.context, ...patch };
+    }
+    /**
+     * Emits a single setup event. `duration_ms` is computed from the time
+     * elapsed since the previous step (or setup start), and `result`
+     * defaults to "success" — callers pass "failure" only when the step's
+     * own code path failed (e.g. writing the editor config threw).
+     */
+    emit(stage, extra = {}, result = "success") {
+        const now = Date.now();
+        const event = {
+            timestamp: new Date(now).toISOString(),
+            source: "mdbmcp",
+            properties: {
+                component: "setup",
+                category: "setup",
+                duration_ms: now - this.stepStartedAt,
+                result,
+                stage,
+                setup_session_id: this.setupSessionId,
+                ...this.context,
+                ...extra,
+            },
+        };
+        this.telemetry.emitEvents([event]);
+        this.stepStartedAt = now;
+        this.lastStep = stage;
+    }
+    emitStarted() {
+        this.emit("started");
+    }
+    emitPrerequisitesChecked(props) {
+        this.updateContext({
+            node_version_ok: toBoolSet(props.nodeVersionOk),
+            has_docker: toBoolSet(props.hasDocker),
+        });
+        this.emit("prerequisites_checked");
+    }
+    emitAiToolSelected(aiTool) {
+        this.updateContext({ ai_tool: aiTool });
+        this.emit("ai_tool_selected");
+    }
+    emitReadOnlySelected(isReadOnly) {
+        this.updateContext({ read_only_mode: toBoolSet(isReadOnly) });
+        this.emit("read_only_selected");
+    }
+    emitConnectionStringEntered(props) {
+        this.updateContext({
+            connection_string_provided: toBoolSet(props.provided),
+            connection_string_tested: toBoolSet(props.tested),
+            connection_test_attempts: props.attempts,
+        });
+        // If the user tested their connection string, surface the final
+        // test result on this step event (success/failure). If they skipped
+        // the test, the step itself still "succeeded" — the user chose not
+        // to validate — so we default to success.
+        this.emit("connection_string_entered", {}, props.testResult ?? "success");
+    }
+    emitServiceAccountIdEntered(provided) {
+        this.updateContext({ service_account_id_provided: toBoolSet(provided) });
+        this.emit("service_account_id_entered");
+    }
+    emitServiceAccountSecretEntered(provided) {
+        this.updateContext({ service_account_secret_provided: toBoolSet(provided) });
+        this.emit("service_account_secret_entered");
+    }
+    emitCredentialsValidated() {
+        this.emit("credentials_validated");
+    }
+    emitEditorConfigured(props) {
+        this.updateContext({
+            used_default_config_path: toBoolSet(props.usedDefaultConfigPath),
+        });
+        this.emit("editor_configured", props.error ? { error_type: errorName(props.error) } : {}, props.result);
+    }
+    emitSkillsInstallPrompted(outcome) {
+        const patch = { skills_install_status: outcome.status };
+        if (outcome.status === "skipped") {
+            patch.skills_skip_reason = outcome.reason;
+        }
+        else if (outcome.status === "failed") {
+            patch.skills_install_exit_code = outcome.exitCode;
+        }
+        this.updateContext(patch);
+        this.emit("skills_install_prompted");
+    }
+    emitOpenConfigPrompted(props) {
+        this.updateContext({ opened_config_file: toBoolSet(props.opened) });
+        this.emit("open_config_prompted", props.error ? { error_type: errorName(props.error) } : {}, props.result);
+    }
+    emitCompleted() {
+        this.emit("completed", { total_duration_ms: Date.now() - this.startedAt });
+    }
+    /**
+     * Emits a cancellation event (e.g. the user hit Ctrl+C). The `result` is
+     * "success" because the cancellation itself was handled gracefully — the
+     * distinct `stage: "cancelled"` is what analytics use to separate
+     * abandoned runs from completed ones.
+     */
+    emitCancelled() {
+        this.emit("cancelled", {
+            last_stage: this.lastStep,
+            total_duration_ms: Date.now() - this.startedAt,
+        });
+    }
+    emitFailed(error) {
+        this.emit("failed", {
+            last_stage: this.lastStep,
+            error_type: errorName(error),
+            total_duration_ms: Date.now() - this.startedAt,
+        }, "failure");
+    }
+    /**
+     * Best-effort flush of any buffered events before the process exits. Also
+     * closes the owned {@link DeviceId}.
+     */
+    async flush() {
+        try {
+            await this.telemetry.close();
+        }
+        catch {
+            // Ignore errors from telemetry.close()
+        }
+        finally {
+            try {
+                this.deviceId.close();
+            }
+            catch {
+                // Ignore errors - it's best-effort
+            }
+        }
+    }
+}
+const errorName = (error) => {
+    if (error && typeof error === "object" && "name" in error && typeof error.name === "string") {
+        return error.name;
+    }
+    return "unknown";
+};
+//# sourceMappingURL=setupTelemetry.js.map

package/dist/setupTelemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupTelemetry.js","sourceRoot":"","sources":["../src/setupTelemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,SAAS,EAAmB,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC3G,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAqBjE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAA0B,EAAgC,EAAE;IAClF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,OAAO,cAAc;IAOvB;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,EACjB,MAAM,EACN,QAAQ,EACR,cAAc,GAKjB;QACG,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzC,kEAAkE;QAClE,MAAM,UAAU,GAAe,oBAAoB,EAAE,CAAC;QACtD,MAAM,SAAS,GAAG,IAAI,SAAS,CAC3B;YACI,OAAO,EAAE,MAAM,CAAC,UAAU;YAC1B,SAAS,EAAE,2BAA2B,CAAC,cAAc,CAAC;YACtD,UAAU;SACb,EACD,MAAM,CACT,CAAC;QACF,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC;YACpC,MAAM;YACN,QAAQ;YACR,SAAS;YACT,QAAQ;YACR,OAAO,EAAE,MAAM,CAAC,SAAS,KAAK,SAAS;YACvC,cAAc;SACjB,CAAC,CAAC;QACH,OAAO,IAAI,cAAc,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IACvD,CAAC;IAKD;;;OAGG;IACH,YAAmB,EAAE,SAAS,EAAE,QAAQ,EAAiD;QAnDxE,mBAAc,GAAW,UAAU,EAAE,CAAC;QACtC,cAAS,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QACxC,kBAAa,GAAW,IAAI,CAAC,SAAS,CAAC;QAEvC,YAAO,GAA0B,EAAE,CAAC;QAgDxC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,KAAqC;QACtD,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,KAAK,EAAE,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACK,IAAI,CACR,KAA0B,EAC1B,QAAgD,EAAE,EAClD,SAA0B,SAAS;QAEnC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,KAAK,GAAwB;YAC/B,SAAS,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE;YACtC,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACR,SAAS,EAAE,OAAO;gBAClB,QAAQ,EAAE,OAAO;gBACjB,WAAW,EAAE,GAAG,GAAG,IAAI,CAAC,aAAa;gBACrC,MAAM;gBACN,KAAK;gBACL,gBAAgB,EAAE,IAAI,CAAC,cAAc;gBACrC,GAAG,IAAI,CAAC,OAAO;gBACf,GAAG,KAAK;aACX;SACJ,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAEnC,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IAC1B,CAAC;IAEM,WAAW;QACd,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACzB,CAAC;IAEM,wBAAwB,CAAC,KAAsD;QAClF,IAAI,CAAC,aAAa,CAAC;YACf,eAAe,EAAE,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC;YAC/C,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC;SACzC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACvC,CAAC;IAEM,kBAAkB,CAAC,MAAc;QACpC,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAClC,CAAC;IAEM,oBAAoB,CAAC,UAAmB;QAC3C,IAAI,CAAC,aAAa,CAAC,EAAE,cAAc,EAAE,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACpC,CAAC;IAEM,2BAA2B,CAAC,KAKlC;QACG,IAAI,CAAC,aAAa,CAAC;YACf,0BAA0B,EAAE,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC;YACrD,wBAAwB,EAAE,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;YACjD,wBAAwB,EAAE,KAAK,CAAC,QAAQ;SAC3C,CAAC,CAAC;QACH,gEAAgE;QAChE,oEAAoE;QACpE,mEAAmE;QACnE,0CAA0C;QAC1C,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,EAAE,KAAK,CAAC,UAAU,IAAI,SAAS,CAAC,CAAC;IAC9E,CAAC;IAEM,2BAA2B,CAAC,QAAiB;QAChD,IAAI,CAAC,aAAa,CAAC,EAAE,2BAA2B,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAC5C,CAAC;IAEM,+BAA+B,CAAC,QAAiB;QACpD,IAAI,CAAC,aAAa,CAAC,EAAE,+BAA+B,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC7E,IAAI,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAChD,CAAC;IAEM,wBAAwB;QAC3B,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACvC,CAAC;IAEM,oBAAoB,CAAC,KAI3B;QACG,IAAI,CAAC,aAAa,CAAC;YACf,wBAAwB,EAAE,SAAS,CAAC,KAAK,CAAC,qBAAqB,CAAC;SACnE,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5G,CAAC;IAEM,yBAAyB,CAAC,OAA6B;QAC1D,MAAM,KAAK,GAA2C,EAAE,qBAAqB,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QAChG,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/B,KAAK,CAAC,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9C,CAAC;aAAM,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACrC,KAAK,CAAC,wBAAwB,GAAG,OAAO,CAAC,QAAQ,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACzC,CAAC;IAEM,sBAAsB,CAAC,KAAoE;QAC9F,IAAI,CAAC,aAAa,CAAC,EAAE,kBAAkB,EAAE,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/G,CAAC;IAEM,aAAa;QAChB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,iBAAiB,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;OAKG;IACI,aAAa;QAChB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACnB,UAAU,EAAE,IAAI,CAAC,QAAQ;YACzB,iBAAiB,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS;SACjD,CAAC,CAAC;IACP,CAAC;IAEM,UAAU,CAAC,KAAc;QAC5B,IAAI,CAAC,IAAI,CACL,QAAQ,EACR;YACI,UAAU,EAAE,IAAI,CAAC,QAAQ;YACzB,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC;YAC5B,iBAAiB,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS;SACjD,EACD,SAAS,CACZ,CAAC;IACN,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK;QACd,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACjC,CAAC;QAAC,MAAM,CAAC;YACL,uCAAuC;QAC3C,CAAC;gBAAS,CAAC;YACP,IAAI,CAAC;gBACD,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC1B,CAAC;YAAC,MAAM,CAAC;gBACL,mCAAmC;YACvC,CAAC;QACL,CAAC;IACL,CAAC;CACJ;AAED,MAAM,SAAS,GAAG,CAAC,KAAc,EAAU,EAAE;IACzC,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1F,OAAO,KAAK,CAAC,IAAI,CAAC;IACtB,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Config interface used by the setup wizard.
+ */
+export interface SetupConfig {
+    apiBaseUrl: string;
+    telemetry: "enabled" | "disabled";
+    connectionString?: string;
+    transport: "stdio" | "http";
+    httpHost: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@mongodb-js/mcp-setup",
+  "version": "3.0.0-prerelease.1",
+  "type": "module",
+  "description": "Setup wizard and configuration for MongoDB MCP server",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "test": "vitest --run",
+    "check": "tsc --build tsconfig.build.json --noEmit"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^8.0.2",
+    "@inquirer/select": "^5.1.3",
+    "@mongodb-js/mcp-atlas-api-client": "workspace:*",
+    "@mongodb-js/mcp-fetch": "workspace:*",
+    "@mongodb-js/mcp-atlas-telemetry": "workspace:*",
+    "@mongodb-js/mcp-core": "workspace:*",
+    "@mongodb-js/mcp-tools-atlas-local": "workspace:*",
+    "@mongodb-js/mcp-tools-mongodb": "workspace:*",
+    "@mongosh/service-provider-node-driver": "^5.0.2",
+    "chalk": "^5.6.2",
+    "jsonc-parser": "^3.3.1",
+    "mongodb-redact": "^1.4.6",
+    "semver": "^7.7.4"
+  },
+  "devDependencies": {
+    "@mongodb-js/mcp-types": "workspace:*",
+    "@mongodb-js/mcp-cli": "workspace:*",
+    "@types/node": "^25.6.0",
+    "@types/semver": "^7.7.0",
+    "typescript": "^5.9.2",
+    "vitest": "^4.1.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}