mongodb-mcp-server 0.2.0 → 0.3.1-prerelease.1

package/dist/esm/common/connectionManager.js

@@ -0,0 +1,233 @@
+import { EventEmitter } from "events";
+import { ConnectionString } from "mongodb-connection-string-url";
+import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
+import { generateConnectionInfoFromCliArgs } from "@mongosh/arg-parser";
+import { defaultDriverOptions, setupDriverConfig } from "./config.js";
+import { MongoDBError, ErrorCodes } from "./errors.js";
+import { LogId } from "./logger.js";
+import { packageInfo } from "./packageInfo.js";
+import { setAppNameParamIfMissing } from "../helpers/connectionOptions.js";
+export class ConnectionManager {
+    constructor() {
+        this.clientName = "unknown";
+        this.events = this._events = new EventEmitter();
+        this.state = { tag: "disconnected" };
+    }
+    get currentConnectionState() {
+        return this.state;
+    }
+    changeState(event, newState) {
+        this.state = newState;
+        // TypeScript doesn't seem to be happy with the spread operator and generics
+        // eslint-disable-next-line
+        this._events.emit(event, ...[newState]);
+        return newState;
+    }
+    setClientName(clientName) {
+        this.clientName = clientName;
+    }
+}
+export class MCPConnectionManager extends ConnectionManager {
+    constructor(userConfig, driverOptions, logger, deviceId, bus) {
+        super();
+        this.userConfig = userConfig;
+        this.driverOptions = driverOptions;
+        this.logger = logger;
+        this.bus = bus ?? new EventEmitter();
+        this.bus.on("mongodb-oidc-plugin:auth-failed", this.onOidcAuthFailed.bind(this));
+        this.bus.on("mongodb-oidc-plugin:auth-succeeded", this.onOidcAuthSucceeded.bind(this));
+        this.deviceId = deviceId;
+    }
+    async connect(settings) {
+        var _a, _b, _c, _d;
+        this._events.emit("connection-request", this.currentConnectionState);
+        if (this.currentConnectionState.tag === "connected" || this.currentConnectionState.tag === "connecting") {
+            await this.disconnect();
+        }
+        let serviceProvider;
+        let connectionInfo;
+        let connectionStringAuthType = "scram";
+        try {
+            settings = { ...settings };
+            const appNameComponents = {
+                appName: `${packageInfo.mcpServerName} ${packageInfo.version}`,
+                deviceId: this.deviceId.get(),
+                clientName: this.clientName,
+            };
+            settings.connectionString = await setAppNameParamIfMissing({
+                connectionString: settings.connectionString,
+                components: appNameComponents,
+            });
+            connectionInfo = generateConnectionInfoFromCliArgs({
+                ...this.userConfig,
+                ...this.driverOptions,
+                connectionSpecifier: settings.connectionString,
+            });
+            if (connectionInfo.driverOptions.oidc) {
+                (_a = connectionInfo.driverOptions.oidc).allowedFlows ?? (_a.allowedFlows = ["auth-code"]);
+                (_b = connectionInfo.driverOptions.oidc).notifyDeviceFlow ?? (_b.notifyDeviceFlow = this.onOidcNotifyDeviceFlow.bind(this));
+            }
+            (_c = connectionInfo.driverOptions).proxy ?? (_c.proxy = { useEnvironmentVariableProxies: true });
+            (_d = connectionInfo.driverOptions).applyProxyToOIDC ?? (_d.applyProxyToOIDC = true);
+            connectionStringAuthType = MCPConnectionManager.inferConnectionTypeFromSettings(this.userConfig, connectionInfo);
+            serviceProvider = await NodeDriverServiceProvider.connect(connectionInfo.connectionString, {
+                productDocsLink: "https://github.com/mongodb-js/mongodb-mcp-server/",
+                productName: "MongoDB MCP",
+                ...connectionInfo.driverOptions,
+            }, undefined, this.bus);
+        }
+        catch (error) {
+            const errorReason = error instanceof Error ? error.message : `${error}`;
+            this.changeState("connection-error", {
+                tag: "errored",
+                errorReason,
+                connectionStringAuthType,
+                connectedAtlasCluster: settings.atlas,
+            });
+            throw new MongoDBError(ErrorCodes.MisconfiguredConnectionString, errorReason);
+        }
+        try {
+            if (connectionStringAuthType.startsWith("oidc")) {
+                void this.pingAndForget(serviceProvider);
+                return this.changeState("connection-request", {
+                    tag: "connecting",
+                    connectedAtlasCluster: settings.atlas,
+                    serviceProvider,
+                    connectionStringAuthType,
+                    oidcConnectionType: connectionStringAuthType,
+                });
+            }
+            await serviceProvider?.runCommand?.("admin", { hello: 1 });
+            return this.changeState("connection-success", {
+                tag: "connected",
+                connectedAtlasCluster: settings.atlas,
+                serviceProvider,
+                connectionStringAuthType,
+            });
+        }
+        catch (error) {
+            const errorReason = error instanceof Error ? error.message : `${error}`;
+            this.changeState("connection-error", {
+                tag: "errored",
+                errorReason,
+                connectionStringAuthType,
+                connectedAtlasCluster: settings.atlas,
+            });
+            throw new MongoDBError(ErrorCodes.NotConnectedToMongoDB, errorReason);
+        }
+    }
+    async disconnect() {
+        if (this.currentConnectionState.tag === "disconnected" || this.currentConnectionState.tag === "errored") {
+            return this.currentConnectionState;
+        }
+        if (this.currentConnectionState.tag === "connected" || this.currentConnectionState.tag === "connecting") {
+            try {
+                await this.currentConnectionState.serviceProvider?.close(true);
+            }
+            finally {
+                this.changeState("connection-close", {
+                    tag: "disconnected",
+                });
+            }
+        }
+        return { tag: "disconnected" };
+    }
+    onOidcAuthFailed(error) {
+        if (this.currentConnectionState.tag === "connecting" &&
+            this.currentConnectionState.connectionStringAuthType?.startsWith("oidc")) {
+            void this.disconnectOnOidcError(error);
+        }
+    }
+    onOidcAuthSucceeded() {
+        if (this.currentConnectionState.tag === "connecting" &&
+            this.currentConnectionState.connectionStringAuthType?.startsWith("oidc")) {
+            this.changeState("connection-success", { ...this.currentConnectionState, tag: "connected" });
+        }
+        this.logger.info({
+            id: LogId.oidcFlow,
+            context: "mongodb-oidc-plugin:auth-succeeded",
+            message: "Authenticated successfully.",
+        });
+    }
+    onOidcNotifyDeviceFlow(flowInfo) {
+        if (this.currentConnectionState.tag === "connecting" &&
+            this.currentConnectionState.connectionStringAuthType?.startsWith("oidc")) {
+            this.changeState("connection-request", {
+                ...this.currentConnectionState,
+                tag: "connecting",
+                connectionStringAuthType: "oidc-device-flow",
+                oidcLoginUrl: flowInfo.verificationUrl,
+                oidcUserCode: flowInfo.userCode,
+            });
+        }
+        this.logger.info({
+            id: LogId.oidcFlow,
+            context: "mongodb-oidc-plugin:notify-device-flow",
+            message: "OIDC Flow changed automatically to device flow.",
+        });
+    }
+    static inferConnectionTypeFromSettings(config, settings) {
+        const connString = new ConnectionString(settings.connectionString);
+        const searchParams = connString.typedSearchParams();
+        switch (searchParams.get("authMechanism")) {
+            case "MONGODB-OIDC": {
+                if (config.transport === "stdio" && config.browser) {
+                    return "oidc-auth-flow";
+                }
+                if (config.transport === "http" && config.httpHost === "127.0.0.1" && config.browser) {
+                    return "oidc-auth-flow";
+                }
+                return "oidc-device-flow";
+            }
+            case "MONGODB-X509":
+                return "x.509";
+            case "GSSAPI":
+                return "kerberos";
+            case "PLAIN":
+                if (searchParams.get("authSource") === "$external") {
+                    return "ldap";
+                }
+                return "scram";
+            // default should catch also null, but eslint complains
+            // about it.
+            case null:
+            default:
+                return "scram";
+        }
+    }
+    async pingAndForget(serviceProvider) {
+        try {
+            await serviceProvider?.runCommand?.("admin", { hello: 1 });
+        }
+        catch (error) {
+            this.logger.warning({
+                id: LogId.oidcFlow,
+                context: "pingAndForget",
+                message: String(error),
+            });
+        }
+    }
+    async disconnectOnOidcError(error) {
+        try {
+            await this.disconnect();
+        }
+        catch (error) {
+            this.logger.warning({
+                id: LogId.oidcFlow,
+                context: "disconnectOnOidcError",
+                message: String(error),
+            });
+        }
+        finally {
+            this.changeState("connection-error", { tag: "errored", errorReason: String(error) });
+        }
+    }
+}
+export const createMCPConnectionManager = ({ logger, deviceId, userConfig }) => {
+    const driverOptions = setupDriverConfig({
+        config: userConfig,
+        defaults: defaultDriverOptions,
+    });
+    return Promise.resolve(new MCPConnectionManager(userConfig, driverOptions, logger, deviceId));
+};
+//# sourceMappingURL=connectionManager.js.map

package/dist/esm/common/connectionManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionManager.js","sourceRoot":"","sources":["../../../src/common/connectionManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAuB,iCAAiC,EAAE,MAAM,qBAAqB,CAAC;AAE7F,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAuC,MAAM,aAAa,CAAC;AAC3G,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAmB,KAAK,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAA0B,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAwEnG,MAAM,OAAgB,iBAAiB;IAMnC;QACI,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,YAAY,EAA2B,CAAC;QACzE,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC;IACzC,CAAC;IAED,IAAI,sBAAsB;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAES,WAAW,CACjB,KAAY,EACZ,QAAe;QAEf,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;QACtB,4EAA4E;QAC5E,2BAA2B;QAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,GAAI,CAAC,QAAQ,CAAS,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,aAAa,CAAC,UAAkB;QAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;CAKJ;AAED,MAAM,OAAO,oBAAqB,SAAQ,iBAAiB;IAIvD,YACY,UAAsB,EACtB,aAA4B,EAC5B,MAAkB,EAC1B,QAAkB,EAClB,GAAkB;QAElB,KAAK,EAAE,CAAC;QANA,eAAU,GAAV,UAAU,CAAY;QACtB,kBAAa,GAAb,aAAa,CAAe;QAC5B,WAAM,GAAN,MAAM,CAAY;QAK1B,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,IAAI,YAAY,EAAE,CAAC;QACrC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,iCAAiC,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACjF,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,oCAAoC,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAA4B;;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAErE,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,WAAW,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,YAAY,EAAE,CAAC;YACtG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC5B,CAAC;QAED,IAAI,eAA0C,CAAC;QAC/C,IAAI,cAA8B,CAAC;QACnC,IAAI,wBAAwB,GAA6B,OAAO,CAAC;QAEjE,IAAI,CAAC;YACD,QAAQ,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;YAC3B,MAAM,iBAAiB,GAAsB;gBACzC,OAAO,EAAE,GAAG,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,OAAO,EAAE;gBAC9D,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;gBAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;aAC9B,CAAC;YAEF,QAAQ,CAAC,gBAAgB,GAAG,MAAM,wBAAwB,CAAC;gBACvD,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;gBAC3C,UAAU,EAAE,iBAAiB;aAChC,CAAC,CAAC;YAEH,cAAc,GAAG,iCAAiC,CAAC;gBAC/C,GAAG,IAAI,CAAC,UAAU;gBAClB,GAAG,IAAI,CAAC,aAAa;gBACrB,mBAAmB,EAAE,QAAQ,CAAC,gBAAgB;aACjD,CAAC,CAAC;YAEH,IAAI,cAAc,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;gBACpC,MAAA,cAAc,CAAC,aAAa,CAAC,IAAI,EAAC,YAAY,QAAZ,YAAY,GAAK,CAAC,WAAW,CAAC,EAAC;gBACjE,MAAA,cAAc,CAAC,aAAa,CAAC,IAAI,EAAC,gBAAgB,QAAhB,gBAAgB,GAAK,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAC;YAClG,CAAC;YAED,MAAA,cAAc,CAAC,aAAa,EAAC,KAAK,QAAL,KAAK,GAAK,EAAE,6BAA6B,EAAE,IAAI,EAAE,EAAC;YAC/E,MAAA,cAAc,CAAC,aAAa,EAAC,gBAAgB,QAAhB,gBAAgB,GAAK,IAAI,EAAC;YAEvD,wBAAwB,GAAG,oBAAoB,CAAC,+BAA+B,CAC3E,IAAI,CAAC,UAAU,EACf,cAAc,CACjB,CAAC;YAEF,eAAe,GAAG,MAAM,yBAAyB,CAAC,OAAO,CACrD,cAAc,CAAC,gBAAgB,EAC/B;gBACI,eAAe,EAAE,mDAAmD;gBACpE,WAAW,EAAE,aAAa;gBAC1B,GAAG,cAAc,CAAC,aAAa;aAClC,EACD,SAAS,EACT,IAAI,CAAC,GAAG,CACX,CAAC;QACN,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM,WAAW,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAe,EAAE,CAAC;YAClF,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;gBACjC,GAAG,EAAE,SAAS;gBACd,WAAW;gBACX,wBAAwB;gBACxB,qBAAqB,EAAE,QAAQ,CAAC,KAAK;aACxC,CAAC,CAAC;YACH,MAAM,IAAI,YAAY,CAAC,UAAU,CAAC,6BAA6B,EAAE,WAAW,CAAC,CAAC;QAClF,CAAC;QAED,IAAI,CAAC;YACD,IAAI,wBAAwB,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9C,KAAK,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;gBAEzC,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;oBAC1C,GAAG,EAAE,YAAY;oBACjB,qBAAqB,EAAE,QAAQ,CAAC,KAAK;oBACrC,eAAe;oBACf,wBAAwB;oBACxB,kBAAkB,EAAE,wBAAkD;iBACzE,CAAC,CAAC;YACP,CAAC;YAED,MAAM,eAAe,EAAE,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YAE3D,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;gBAC1C,GAAG,EAAE,WAAW;gBAChB,qBAAqB,EAAE,QAAQ,CAAC,KAAK;gBACrC,eAAe;gBACf,wBAAwB;aAC3B,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM,WAAW,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAe,EAAE,CAAC;YAClF,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;gBACjC,GAAG,EAAE,SAAS;gBACd,WAAW;gBACX,wBAAwB;gBACxB,qBAAqB,EAAE,QAAQ,CAAC,KAAK;aACxC,CAAC,CAAC;YACH,MAAM,IAAI,YAAY,CAAC,UAAU,CAAC,qBAAqB,EAAE,WAAW,CAAC,CAAC;QAC1E,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU;QACZ,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACtG,OAAO,IAAI,CAAC,sBAAsB,CAAC;QACvC,CAAC;QAED,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,WAAW,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,YAAY,EAAE,CAAC;YACtG,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,sBAAsB,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACnE,CAAC;oBAAS,CAAC;gBACP,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;oBACjC,GAAG,EAAE,cAAc;iBACtB,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QAED,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC;IACnC,CAAC;IAEO,gBAAgB,CAAC,KAAc;QACnC,IACI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,YAAY;YAChD,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,EAAE,UAAU,CAAC,MAAM,CAAC,EAC1E,CAAC;YACC,KAAK,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;IAEO,mBAAmB;QACvB,IACI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,YAAY;YAChD,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,EAAE,UAAU,CAAC,MAAM,CAAC,EAC1E,CAAC;YACC,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,EAAE,GAAG,IAAI,CAAC,sBAAsB,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;QACjG,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACb,EAAE,EAAE,KAAK,CAAC,QAAQ;YAClB,OAAO,EAAE,oCAAoC;YAC7C,OAAO,EAAE,6BAA6B;SACzC,CAAC,CAAC;IACP,CAAC;IAEO,sBAAsB,CAAC,QAAuD;QAClF,IACI,IAAI,CAAC,sBAAsB,CAAC,GAAG,KAAK,YAAY;YAChD,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,EAAE,UAAU,CAAC,MAAM,CAAC,EAC1E,CAAC;YACC,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;gBACnC,GAAG,IAAI,CAAC,sBAAsB;gBAC9B,GAAG,EAAE,YAAY;gBACjB,wBAAwB,EAAE,kBAAkB;gBAC5C,YAAY,EAAE,QAAQ,CAAC,eAAe;gBACtC,YAAY,EAAE,QAAQ,CAAC,QAAQ;aAClC,CAAC,CAAC;QACP,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACb,EAAE,EAAE,KAAK,CAAC,QAAQ;YAClB,OAAO,EAAE,wCAAwC;YACjD,OAAO,EAAE,iDAAiD;SAC7D,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,+BAA+B,CAClC,MAAkB,EAClB,QAAsC;QAEtC,MAAM,UAAU,GAAG,IAAI,gBAAgB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACnE,MAAM,YAAY,GAAG,UAAU,CAAC,iBAAiB,EAAsB,CAAC;QAExE,QAAQ,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YACxC,KAAK,cAAc,CAAC,CAAC,CAAC;gBAClB,IAAI,MAAM,CAAC,SAAS,KAAK,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACjD,OAAO,gBAAgB,CAAC;gBAC5B,CAAC;gBAED,IAAI,MAAM,CAAC,SAAS,KAAK,MAAM,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACnF,OAAO,gBAAgB,CAAC;gBAC5B,CAAC;gBAED,OAAO,kBAAkB,CAAC;YAC9B,CAAC;YACD,KAAK,cAAc;gBACf,OAAO,OAAO,CAAC;YACnB,KAAK,QAAQ;gBACT,OAAO,UAAU,CAAC;YACtB,KAAK,OAAO;gBACR,IAAI,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,WAAW,EAAE,CAAC;oBACjD,OAAO,MAAM,CAAC;gBAClB,CAAC;gBACD,OAAO,OAAO,CAAC;YACnB,uDAAuD;YACvD,YAAY;YACZ,KAAK,IAAI,CAAC;YACV;gBACI,OAAO,OAAO,CAAC;QACvB,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,eAA0C;QAClE,IAAI,CAAC;YACD,MAAM,eAAe,EAAE,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC/D,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBAChB,EAAE,EAAE,KAAK,CAAC,QAAQ;gBAClB,OAAO,EAAE,eAAe;gBACxB,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;aACzB,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAC,KAAc;QAC9C,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC5B,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBAChB,EAAE,EAAE,KAAK,CAAC,QAAQ;gBAClB,OAAO,EAAE,uBAAuB;gBAChC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;aACzB,CAAC,CAAC;QACP,CAAC;gBAAS,CAAC;YACP,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzF,CAAC;IACL,CAAC;CACJ;AAaD,MAAM,CAAC,MAAM,0BAA0B,GAA+B,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE;IACvG,MAAM,aAAa,GAAG,iBAAiB,CAAC;QACpC,MAAM,EAAE,UAAU;QAClB,QAAQ,EAAE,oBAAoB;KACjC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,oBAAoB,CAAC,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAClG,CAAC,CAAC"}

package/dist/esm/common/errors.d.ts

@@ -0,0 +1,11 @@
+export declare enum ErrorCodes {
+    NotConnectedToMongoDB = 1000000,
+    MisconfiguredConnectionString = 1000001,
+    ForbiddenCollscan = 1000002,
+    ForbiddenWriteOperation = 1000003
+}
+export declare class MongoDBError<ErrorCode extends ErrorCodes = ErrorCodes> extends Error {
+    code: ErrorCode;
+    constructor(code: ErrorCode, message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/esm/common/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/common/errors.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU;IAClB,qBAAqB,UAAY;IACjC,6BAA6B,UAAY;IACzC,iBAAiB,UAAY;IAC7B,uBAAuB,UAAY;CACtC;AAED,qBAAa,YAAY,CAAC,SAAS,SAAS,UAAU,GAAG,UAAU,CAAE,SAAQ,KAAK;IAEnE,IAAI,EAAE,SAAS;gBAAf,IAAI,EAAE,SAAS,EACtB,OAAO,EAAE,MAAM;CAItB"}

package/dist/esm/common/errors.js

@@ -0,0 +1,14 @@
+export var ErrorCodes;
+(function (ErrorCodes) {
+    ErrorCodes[ErrorCodes["NotConnectedToMongoDB"] = 1000000] = "NotConnectedToMongoDB";
+    ErrorCodes[ErrorCodes["MisconfiguredConnectionString"] = 1000001] = "MisconfiguredConnectionString";
+    ErrorCodes[ErrorCodes["ForbiddenCollscan"] = 1000002] = "ForbiddenCollscan";
+    ErrorCodes[ErrorCodes["ForbiddenWriteOperation"] = 1000003] = "ForbiddenWriteOperation";
+})(ErrorCodes || (ErrorCodes = {}));
+export class MongoDBError extends Error {
+    constructor(code, message) {
+        super(message);
+        this.code = code;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/esm/common/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/common/errors.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,mFAAiC,CAAA;IACjC,mGAAyC,CAAA;IACzC,2EAA6B,CAAA;IAC7B,uFAAmC,CAAA;AACvC,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAED,MAAM,OAAO,YAAwD,SAAQ,KAAK;IAC9E,YACW,IAAe,EACtB,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,SAAI,GAAJ,IAAI,CAAW;IAI1B,CAAC;CACJ"}

package/dist/esm/common/exportsManager.d.ts

@@ -0,0 +1,86 @@
+import z from "zod";
+import EventEmitter from "events";
+import type { AggregationCursor, FindCursor } from "mongodb";
+import type { UserConfig } from "./config.js";
+import type { LoggerBase } from "./logger.js";
+export declare const jsonExportFormat: z.ZodEnum<["relaxed", "canonical"]>;
+export type JSONExportFormat = z.infer<typeof jsonExportFormat>;
+interface CommonExportData {
+    exportName: string;
+    exportTitle: string;
+    exportURI: string;
+    exportPath: string;
+}
+interface ReadyExport extends CommonExportData {
+    exportStatus: "ready";
+    exportCreatedAt: number;
+}
+interface InProgressExport extends CommonExportData {
+    exportStatus: "in-progress";
+}
+type StoredExport = ReadyExport | InProgressExport;
+/**
+ * Ideally just exportName and exportURI should be made publicly available but
+ * we also make exportPath available because the export tool, also returns the
+ * exportPath in its response when the MCP server is running connected to stdio
+ * transport. The reasoning behind this is that a few clients, Cursor in
+ * particular, as of the date of this writing (7 August 2025) cannot refer to
+ * resource URIs which means they have no means to access the exported resource.
+ * As of this writing, majority of the usage of our MCP server is behind STDIO
+ * transport so we can assume that for most of the usages, if not all, the MCP
+ * server will be running on the same machine as of the MCP client and thus we
+ * can provide the local path to export so that these clients which do not still
+ * support parsing resource URIs, can still work with the exported data. We
+ * expect for clients to catch up and implement referencing resource URIs at
+ * which point it would be safe to remove the `exportPath` from the publicly
+ * exposed properties of an export.
+ *
+ * The editors that we would like to watch out for are Cursor and Windsurf as
+ * they don't yet support working with Resource URIs.
+ *
+ * Ref Cursor: https://forum.cursor.com/t/cursor-mcp-resource-feature-support/50987
+ * JIRA: https://jira.mongodb.org/browse/MCP-104 */
+export type AvailableExport = Pick<StoredExport, "exportName" | "exportTitle" | "exportURI" | "exportPath">;
+export type ExportsManagerConfig = Pick<UserConfig, "exportsPath" | "exportTimeoutMs" | "exportCleanupIntervalMs">;
+type ExportsManagerEvents = {
+    closed: [];
+    "export-expired": [string];
+    "export-available": [string];
+};
+export declare class ExportsManager extends EventEmitter<ExportsManagerEvents> {
+    private readonly exportsDirectoryPath;
+    private readonly config;
+    private readonly logger;
+    private storedExports;
+    private exportsCleanupInProgress;
+    private exportsCleanupInterval?;
+    private readonly shutdownController;
+    private constructor();
+    get availableExports(): AvailableExport[];
+    protected init(): void;
+    close(): Promise<void>;
+    readExport(exportName: string): Promise<string>;
+    createJSONExport({ input, exportName, exportTitle, jsonExportFormat, }: {
+        input: FindCursor | AggregationCursor;
+        exportName: string;
+        exportTitle: string;
+        jsonExportFormat: JSONExportFormat;
+    }): Promise<AvailableExport>;
+    private startExport;
+    private getEJSONOptionsForFormat;
+    private docToEJSONStream;
+    private cleanupExpiredExports;
+    private silentlyRemoveExport;
+    private assertIsNotShuttingDown;
+    static init(config: ExportsManagerConfig, logger: LoggerBase, sessionId?: string): ExportsManager;
+}
+/**
+ * Ensures the path ends with the provided extension */
+export declare function ensureExtension(pathOrName: string, extension: string): string;
+/**
+ * Small utility to decoding and validating provided export name for path
+ * traversal or no extension */
+export declare function validateExportName(nameWithExtension: string): string;
+export declare function isExportExpired(createdAt: number, exportTimeoutMs: number): boolean;
+export {};
+//# sourceMappingURL=exportsManager.d.ts.map

package/dist/esm/common/exportsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exportsManager.d.ts","sourceRoot":"","sources":["../../../src/common/exportsManager.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAGpB,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAO7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAG9C,eAAO,MAAM,gBAAgB,qCAAmC,CAAC;AACjE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEhE,UAAU,gBAAgB;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,WAAY,SAAQ,gBAAgB;IAC1C,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,UAAU,gBAAiB,SAAQ,gBAAgB;IAC/C,YAAY,EAAE,aAAa,CAAC;CAC/B;AAED,KAAK,YAAY,GAAG,WAAW,GAAG,gBAAgB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;mDAoBmD;AACnD,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,aAAa,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC;AAE5G,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,UAAU,EAAE,aAAa,GAAG,iBAAiB,GAAG,yBAAyB,CAAC,CAAC;AAEnH,KAAK,oBAAoB,GAAG;IACxB,MAAM,EAAE,EAAE,CAAC;IACX,gBAAgB,EAAE,CAAC,MAAM,CAAC,CAAC;IAC3B,kBAAkB,EAAE,CAAC,MAAM,CAAC,CAAC;CAChC,CAAC;AAEF,qBAAa,cAAe,SAAQ,YAAY,CAAC,oBAAoB,CAAC;IAO9D,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAR3B,OAAO,CAAC,aAAa,CAAwD;IAC7E,OAAO,CAAC,wBAAwB,CAAkB;IAClD,OAAO,CAAC,sBAAsB,CAAC,CAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA0C;IAE7E,OAAO;IAQP,IAAW,gBAAgB,IAAI,eAAe,EAAE,CAe/C;IAED,SAAS,CAAC,IAAI,IAAI,IAAI;IAST,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBtB,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA0B/C,gBAAgB,CAAC,EAC1B,KAAK,EACL,UAAU,EACV,WAAW,EACX,gBAAgB,GACnB,EAAE;QACC,KAAK,EAAE,UAAU,GAAG,iBAAiB,CAAC;QACtC,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,gBAAgB,EAAE,gBAAgB,CAAC;KACtC,GAAG,OAAO,CAAC,eAAe,CAAC;YA+Bd,WAAW;IAsDzB,OAAO,CAAC,wBAAwB;IAWhC,OAAO,CAAC,gBAAgB;YA6BV,qBAAqB;YA2CrB,oBAAoB;IAiBlC,OAAO,CAAC,uBAAuB;IAM/B,MAAM,CAAC,IAAI,CACP,MAAM,EAAE,oBAAoB,EAC5B,MAAM,EAAE,UAAU,EAClB,SAAS,SAA4B,GACtC,cAAc;CAMpB;AAED;uDACuD;AACvD,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAM7E;AAED;;+BAE+B;AAC/B,wBAAgB,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAWpE;AAED,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAEnF"}

package/dist/esm/common/exportsManager.js

@@ -0,0 +1,278 @@
+import z from "zod";
+import path from "path";
+import fs from "fs/promises";
+import EventEmitter from "events";
+import { createWriteStream } from "fs";
+import { EJSON, ObjectId } from "bson";
+import { Transform } from "stream";
+import { pipeline } from "stream/promises";
+import { LogId } from "./logger.js";
+export const jsonExportFormat = z.enum(["relaxed", "canonical"]);
+export class ExportsManager extends EventEmitter {
+    constructor(exportsDirectoryPath, config, logger) {
+        super();
+        this.exportsDirectoryPath = exportsDirectoryPath;
+        this.config = config;
+        this.logger = logger;
+        this.storedExports = {};
+        this.exportsCleanupInProgress = false;
+        this.shutdownController = new AbortController();
+    }
+    get availableExports() {
+        this.assertIsNotShuttingDown();
+        return Object.values(this.storedExports)
+            .filter((storedExport) => {
+            return (storedExport.exportStatus === "ready" &&
+                !isExportExpired(storedExport.exportCreatedAt, this.config.exportTimeoutMs));
+        })
+            .map(({ exportName, exportTitle, exportURI, exportPath }) => ({
+            exportName,
+            exportTitle,
+            exportURI,
+            exportPath,
+        }));
+    }
+    init() {
+        if (!this.exportsCleanupInterval) {
+            this.exportsCleanupInterval = setInterval(() => void this.cleanupExpiredExports(), this.config.exportCleanupIntervalMs);
+        }
+    }
+    async close() {
+        if (this.shutdownController.signal.aborted) {
+            return;
+        }
+        try {
+            clearInterval(this.exportsCleanupInterval);
+            this.shutdownController.abort();
+            await fs.rm(this.exportsDirectoryPath, { force: true, recursive: true });
+            this.emit("closed");
+        }
+        catch (error) {
+            this.logger.error({
+                id: LogId.exportCloseError,
+                context: "Error while closing ExportsManager",
+                message: error instanceof Error ? error.message : String(error),
+            });
+        }
+    }
+    async readExport(exportName) {
+        try {
+            this.assertIsNotShuttingDown();
+            exportName = decodeURIComponent(exportName);
+            const exportHandle = this.storedExports[exportName];
+            if (!exportHandle) {
+                throw new Error("Requested export has either expired or does not exist.");
+            }
+            if (exportHandle.exportStatus === "in-progress") {
+                throw new Error("Requested export is still being generated. Try again later.");
+            }
+            const { exportPath } = exportHandle;
+            return fs.readFile(exportPath, { encoding: "utf8", signal: this.shutdownController.signal });
+        }
+        catch (error) {
+            this.logger.error({
+                id: LogId.exportReadError,
+                context: `Error when reading export - ${exportName}`,
+                message: error instanceof Error ? error.message : String(error),
+            });
+            throw error;
+        }
+    }
+    async createJSONExport({ input, exportName, exportTitle, jsonExportFormat, }) {
+        try {
+            this.assertIsNotShuttingDown();
+            const exportNameWithExtension = validateExportName(ensureExtension(exportName, "json"));
+            if (this.storedExports[exportNameWithExtension]) {
+                return Promise.reject(new Error("Export with same name is either already available or being generated."));
+            }
+            const exportURI = `exported-data://${encodeURIComponent(exportNameWithExtension)}`;
+            const exportFilePath = path.join(this.exportsDirectoryPath, exportNameWithExtension);
+            const inProgressExport = (this.storedExports[exportNameWithExtension] = {
+                exportName: exportNameWithExtension,
+                exportTitle,
+                exportPath: exportFilePath,
+                exportURI: exportURI,
+                exportStatus: "in-progress",
+            });
+            void this.startExport({ input, jsonExportFormat, inProgressExport });
+            return Promise.resolve(inProgressExport);
+        }
+        catch (error) {
+            this.logger.error({
+                id: LogId.exportCreationError,
+                context: "Error when registering JSON export request",
+                message: error instanceof Error ? error.message : String(error),
+            });
+            throw error;
+        }
+    }
+    async startExport({ input, jsonExportFormat, inProgressExport, }) {
+        try {
+            let pipeSuccessful = false;
+            try {
+                await fs.mkdir(this.exportsDirectoryPath, { recursive: true });
+                const outputStream = createWriteStream(inProgressExport.exportPath);
+                await pipeline([
+                    input.stream(),
+                    this.docToEJSONStream(this.getEJSONOptionsForFormat(jsonExportFormat)),
+                    outputStream,
+                ], { signal: this.shutdownController.signal });
+                pipeSuccessful = true;
+            }
+            catch (error) {
+                // If the pipeline errors out then we might end up with
+                // partial and incorrect export so we remove it entirely.
+                delete this.storedExports[inProgressExport.exportName];
+                // do not block the user, just delete the file in the background
+                void this.silentlyRemoveExport(inProgressExport.exportPath, LogId.exportCreationCleanupError, `Error when removing incomplete export ${inProgressExport.exportName}`);
+                throw error;
+            }
+            finally {
+                if (pipeSuccessful) {
+                    this.storedExports[inProgressExport.exportName] = {
+                        ...inProgressExport,
+                        exportCreatedAt: Date.now(),
+                        exportStatus: "ready",
+                    };
+                    this.emit("export-available", inProgressExport.exportURI);
+                }
+                void input.close();
+            }
+        }
+        catch (error) {
+            this.logger.error({
+                id: LogId.exportCreationError,
+                context: `Error when generating JSON export for ${inProgressExport.exportName}`,
+                message: error instanceof Error ? error.message : String(error),
+            });
+        }
+    }
+    getEJSONOptionsForFormat(format) {
+        switch (format) {
+            case "relaxed":
+                return { relaxed: true };
+            case "canonical":
+                return { relaxed: false };
+            default:
+                return undefined;
+        }
+    }
+    docToEJSONStream(ejsonOptions) {
+        let docsTransformed = 0;
+        return new Transform({
+            objectMode: true,
+            transform(chunk, encoding, callback) {
+                try {
+                    const doc = EJSON.stringify(chunk, undefined, undefined, ejsonOptions);
+                    if (docsTransformed === 0) {
+                        this.push("[" + doc);
+                    }
+                    else {
+                        this.push(",\n" + doc);
+                    }
+                    docsTransformed++;
+                    callback();
+                }
+                catch (err) {
+                    callback(err);
+                }
+            },
+            flush(callback) {
+                if (docsTransformed === 0) {
+                    this.push("[]");
+                }
+                else {
+                    this.push("]");
+                }
+                callback();
+            },
+        });
+    }
+    async cleanupExpiredExports() {
+        if (this.exportsCleanupInProgress) {
+            return;
+        }
+        this.exportsCleanupInProgress = true;
+        try {
+            // first, unregister all exports that are expired, so they are not considered anymore for reading
+            const exportsForCleanup = [];
+            for (const expiredExport of Object.values(this.storedExports)) {
+                if (expiredExport.exportStatus === "ready" &&
+                    isExportExpired(expiredExport.exportCreatedAt, this.config.exportTimeoutMs)) {
+                    exportsForCleanup.push(expiredExport);
+                    delete this.storedExports[expiredExport.exportName];
+                }
+            }
+            // and then remove them (slow operation potentially) from disk.
+            const allDeletionPromises = [];
+            for (const { exportPath, exportName } of exportsForCleanup) {
+                allDeletionPromises.push(this.silentlyRemoveExport(exportPath, LogId.exportCleanupError, `Considerable error when removing export ${exportName}`));
+            }
+            await Promise.allSettled(allDeletionPromises);
+        }
+        catch (error) {
+            this.logger.error({
+                id: LogId.exportCleanupError,
+                context: "Error when cleaning up exports",
+                message: error instanceof Error ? error.message : String(error),
+            });
+        }
+        finally {
+            this.exportsCleanupInProgress = false;
+        }
+    }
+    async silentlyRemoveExport(exportPath, logId, logContext) {
+        try {
+            await fs.unlink(exportPath);
+        }
+        catch (error) {
+            // If the file does not exist or the containing directory itself
+            // does not exist then we can safely ignore that error anything else
+            // we need to flag.
+            if (error.code !== "ENOENT") {
+                this.logger.error({
+                    id: logId,
+                    context: logContext,
+                    message: error instanceof Error ? error.message : String(error),
+                });
+            }
+        }
+    }
+    assertIsNotShuttingDown() {
+        if (this.shutdownController.signal.aborted) {
+            throw new Error("ExportsManager is shutting down.");
+        }
+    }
+    static init(config, logger, sessionId = new ObjectId().toString()) {
+        const exportsDirectoryPath = path.join(config.exportsPath, sessionId);
+        const exportsManager = new ExportsManager(exportsDirectoryPath, config, logger);
+        exportsManager.init();
+        return exportsManager;
+    }
+}
+/**
+ * Ensures the path ends with the provided extension */
+export function ensureExtension(pathOrName, extension) {
+    const extWithDot = extension.startsWith(".") ? extension : `.${extension}`;
+    if (pathOrName.endsWith(extWithDot)) {
+        return pathOrName;
+    }
+    return `${pathOrName}${extWithDot}`;
+}
+/**
+ * Small utility to decoding and validating provided export name for path
+ * traversal or no extension */
+export function validateExportName(nameWithExtension) {
+    const decodedName = decodeURIComponent(nameWithExtension);
+    if (!path.extname(decodedName)) {
+        throw new Error("Provided export name has no extension");
+    }
+    if (decodedName.includes("..") || decodedName.includes("/") || decodedName.includes("\\")) {
+        throw new Error("Invalid export name: path traversal hinted");
+    }
+    return decodedName;
+}
+export function isExportExpired(createdAt, exportTimeoutMs) {
+    return Date.now() - createdAt > exportTimeoutMs;
+}
+//# sourceMappingURL=exportsManager.js.map