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

package/dist/esm/common/config.js

@@ -0,0 +1,372 @@
+import path from "path";
+import os from "os";
+import argv from "yargs-parser";
+import { generateConnectionInfoFromCliArgs } from "@mongosh/arg-parser";
+import { Keychain } from "./keychain.js";
+import levenshtein from "ts-levenshtein";
+// From: https://github.com/mongodb-js/mongosh/blob/main/packages/cli-repl/src/arg-parser.ts
+const OPTIONS = {
+    string: [
+        "apiBaseUrl",
+        "apiClientId",
+        "apiClientSecret",
+        "connectionString",
+        "httpHost",
+        "httpPort",
+        "idleTimeoutMs",
+        "logPath",
+        "notificationTimeoutMs",
+        "telemetry",
+        "transport",
+        "apiVersion",
+        "authenticationDatabase",
+        "authenticationMechanism",
+        "browser",
+        "db",
+        "gssapiHostName",
+        "gssapiServiceName",
+        "host",
+        "oidcFlows",
+        "oidcRedirectUri",
+        "password",
+        "port",
+        "sslCAFile",
+        "sslCRLFile",
+        "sslCertificateSelector",
+        "sslDisabledProtocols",
+        "sslPEMKeyFile",
+        "sslPEMKeyPassword",
+        "sspiHostnameCanonicalization",
+        "sspiRealmOverride",
+        "tlsCAFile",
+        "tlsCRLFile",
+        "tlsCertificateKeyFile",
+        "tlsCertificateKeyFilePassword",
+        "tlsCertificateSelector",
+        "tlsDisabledProtocols",
+        "username",
+    ],
+    boolean: [
+        "apiDeprecationErrors",
+        "apiStrict",
+        "help",
+        "indexCheck",
+        "ipv6",
+        "nodb",
+        "oidcIdTokenAsAccessToken",
+        "oidcNoNonce",
+        "oidcTrustedEndpoint",
+        "readOnly",
+        "retryWrites",
+        "ssl",
+        "sslAllowInvalidCertificates",
+        "sslAllowInvalidHostnames",
+        "sslFIPSMode",
+        "tls",
+        "tlsAllowInvalidCertificates",
+        "tlsAllowInvalidHostnames",
+        "tlsFIPSMode",
+        "version",
+    ],
+    array: ["disabledTools", "loggers"],
+    alias: {
+        h: "help",
+        p: "password",
+        u: "username",
+        "build-info": "buildInfo",
+        browser: "browser",
+        oidcDumpTokens: "oidcDumpTokens",
+        oidcRedirectUrl: "oidcRedirectUri",
+        oidcIDTokenAsAccessToken: "oidcIdTokenAsAccessToken",
+    },
+    configuration: {
+        "camel-case-expansion": false,
+        "unknown-options-as-args": true,
+        "parse-positional-numbers": false,
+        "parse-numbers": false,
+        "greedy-arrays": true,
+        "short-option-groups": false,
+    },
+};
+const ALL_CONFIG_KEYS = new Set(OPTIONS.string
+    .concat(OPTIONS.array)
+    .concat(OPTIONS.boolean)
+    .concat(Object.keys(OPTIONS.alias)));
+export function validateConfigKey(key) {
+    if (ALL_CONFIG_KEYS.has(key)) {
+        return { valid: true };
+    }
+    let minLev = Number.MAX_VALUE;
+    let suggestion = "";
+    // find the closest match for a suggestion
+    for (const validKey of ALL_CONFIG_KEYS) {
+        // check if there is an exact case-insensitive match
+        if (validKey.toLowerCase() === key.toLowerCase()) {
+            return { valid: false, suggestion: validKey };
+        }
+        // else, infer something using levenshtein so we suggest a valid key
+        const lev = levenshtein.get(key, validKey);
+        if (lev < minLev) {
+            minLev = lev;
+            suggestion = validKey;
+        }
+    }
+    if (minLev <= 2) {
+        // accept up to 2 typos
+        return { valid: false, suggestion };
+    }
+    return { valid: false };
+}
+function isConnectionSpecifier(arg) {
+    return (arg !== undefined &&
+        (arg.startsWith("mongodb://") ||
+            arg.startsWith("mongodb+srv://") ||
+            !(arg.endsWith(".js") || arg.endsWith(".mongodb"))));
+}
+export const defaultUserConfig = {
+    apiBaseUrl: "https://cloud.mongodb.com/",
+    logPath: getLogPath(),
+    exportsPath: getExportsPath(),
+    exportTimeoutMs: 300000, // 5 minutes
+    exportCleanupIntervalMs: 120000, // 2 minutes
+    disabledTools: [],
+    telemetry: "enabled",
+    readOnly: false,
+    indexCheck: false,
+    transport: "stdio",
+    httpPort: 3000,
+    httpHost: "127.0.0.1",
+    loggers: ["disk", "mcp"],
+    idleTimeoutMs: 600000, // 10 minutes
+    notificationTimeoutMs: 540000, // 9 minutes
+    httpHeaders: {},
+};
+export const config = setupUserConfig({
+    defaults: defaultUserConfig,
+    cli: process.argv,
+    env: process.env,
+});
+function getLocalDataPath() {
+    return process.platform === "win32"
+        ? path.join(process.env.LOCALAPPDATA || process.env.APPDATA || os.homedir(), "mongodb")
+        : path.join(os.homedir(), ".mongodb");
+}
+export const defaultDriverOptions = {
+    readConcern: {
+        level: "local",
+    },
+    readPreference: "secondaryPreferred",
+    writeConcern: {
+        w: "majority",
+    },
+    timeoutMS: 30000,
+    proxy: { useEnvironmentVariableProxies: true },
+    applyProxyToOIDC: true,
+};
+export const driverOptions = setupDriverConfig({
+    config,
+    defaults: defaultDriverOptions,
+});
+function getLogPath() {
+    const logPath = path.join(getLocalDataPath(), "mongodb-mcp", ".app-logs");
+    return logPath;
+}
+function getExportsPath() {
+    return path.join(getLocalDataPath(), "mongodb-mcp", "exports");
+}
+// Gets the config supplied by the user as environment variables. The variable names
+// are prefixed with `MDB_MCP_` and the keys match the UserConfig keys, but are converted
+// to SNAKE_UPPER_CASE.
+function parseEnvConfig(env) {
+    const CONFIG_WITH_URLS = new Set(["connectionString"]);
+    function setValue(obj, path, value) {
+        const currentField = path.shift();
+        if (!currentField) {
+            return;
+        }
+        if (path.length === 0) {
+            if (CONFIG_WITH_URLS.has(currentField)) {
+                obj[currentField] = value;
+                return;
+            }
+            const numberValue = Number(value);
+            if (!isNaN(numberValue)) {
+                obj[currentField] = numberValue;
+                return;
+            }
+            const booleanValue = value.toLocaleLowerCase();
+            if (booleanValue === "true" || booleanValue === "false") {
+                obj[currentField] = booleanValue === "true";
+                return;
+            }
+            // Try to parse an array of values
+            if (value.indexOf(",") !== -1) {
+                obj[currentField] = value.split(",").map((v) => v.trim());
+                return;
+            }
+            obj[currentField] = value;
+            return;
+        }
+        if (!obj[currentField]) {
+            obj[currentField] = {};
+        }
+        setValue(obj[currentField], path, value);
+    }
+    const result = {};
+    const mcpVariables = Object.entries(env).filter(([key, value]) => value !== undefined && key.startsWith("MDB_MCP_"));
+    for (const [key, value] of mcpVariables) {
+        const fieldPath = key
+            .replace("MDB_MCP_", "")
+            .split(".")
+            .map((part) => SNAKE_CASE_toCamelCase(part));
+        setValue(result, fieldPath, value);
+    }
+    return result;
+}
+function SNAKE_CASE_toCamelCase(str) {
+    return str.toLowerCase().replace(/([-_][a-z])/g, (group) => group.toUpperCase().replace("_", ""));
+}
+// Right now we have arguments that are not compatible with the format used in mongosh.
+// An example is using --connectionString and positional arguments.
+// We will consolidate them in a way where the mongosh format takes precedence.
+// We will warn users that previous configuration is deprecated in favour of
+// whatever is in mongosh.
+function parseCliConfig(args) {
+    const programArgs = args.slice(2);
+    const parsed = argv(programArgs, OPTIONS);
+    const positionalArguments = parsed._ ?? [];
+    // we use console.warn here because we still don't have our logging system configured
+    // so we don't have a logger. For stdio, the warning will be received as a string in
+    // the client and IDEs like VSCode do show the message in the log window. For HTTP,
+    // it will be in the stdout of the process.
+    warnAboutDeprecatedOrUnknownCliArgs({ ...parsed, _: positionalArguments }, {
+        warn: (msg) => console.warn(msg),
+        exit: (status) => process.exit(status),
+    });
+    // if we have a positional argument that matches a connection string
+    // store it as the connection specifier and remove it from the argument
+    // list, so it doesn't get misunderstood by the mongosh args-parser
+    if (!parsed.nodb && isConnectionSpecifier(positionalArguments[0])) {
+        parsed.connectionSpecifier = positionalArguments.shift();
+    }
+    delete parsed._;
+    return parsed;
+}
+export function warnAboutDeprecatedOrUnknownCliArgs(args, { warn, exit }) {
+    let usedDeprecatedArgument = false;
+    let usedInvalidArgument = false;
+    const knownArgs = args;
+    // the first position argument should be used
+    // instead of --connectionString, as it's how the mongosh works.
+    if (knownArgs.connectionString) {
+        usedDeprecatedArgument = true;
+        warn("The --connectionString argument is deprecated. Prefer using the first positional argument for the connection string or the MDB_MCP_CONNECTION_STRING environment variable.");
+    }
+    for (const providedKey of Object.keys(args)) {
+        if (providedKey === "_") {
+            // positional argument
+            continue;
+        }
+        const { valid, suggestion } = validateConfigKey(providedKey);
+        if (!valid) {
+            usedInvalidArgument = true;
+            if (suggestion) {
+                warn(`Invalid command line argument '${providedKey}'. Did you mean '${suggestion}'?`);
+            }
+            else {
+                warn(`Invalid command line argument '${providedKey}'.`);
+            }
+        }
+    }
+    if (usedInvalidArgument || usedDeprecatedArgument) {
+        warn("Refer to https://www.mongodb.com/docs/mcp-server/get-started/ for setting up the MCP Server.");
+    }
+    if (usedInvalidArgument) {
+        exit(1);
+    }
+}
+function commaSeparatedToArray(str) {
+    if (str === undefined) {
+        return [];
+    }
+    if (!Array.isArray(str)) {
+        return [str];
+    }
+    if (str.length === 0) {
+        return str;
+    }
+    if (str.length === 1) {
+        return str[0]
+            ?.split(",")
+            .map((e) => e.trim())
+            .filter((e) => e.length > 0);
+    }
+    return str;
+}
+export function registerKnownSecretsInRootKeychain(userConfig) {
+    const keychain = Keychain.root;
+    const maybeRegister = (value, kind) => {
+        if (value) {
+            keychain.register(value, kind);
+        }
+    };
+    maybeRegister(userConfig.apiClientId, "user");
+    maybeRegister(userConfig.apiClientSecret, "password");
+    maybeRegister(userConfig.awsAccessKeyId, "password");
+    maybeRegister(userConfig.awsIamSessionToken, "password");
+    maybeRegister(userConfig.awsSecretAccessKey, "password");
+    maybeRegister(userConfig.awsSessionToken, "password");
+    maybeRegister(userConfig.password, "password");
+    maybeRegister(userConfig.tlsCAFile, "url");
+    maybeRegister(userConfig.tlsCRLFile, "url");
+    maybeRegister(userConfig.tlsCertificateKeyFile, "url");
+    maybeRegister(userConfig.tlsCertificateKeyFilePassword, "password");
+    maybeRegister(userConfig.username, "user");
+}
+export function setupUserConfig({ cli, env, defaults, }) {
+    const userConfig = {
+        ...defaults,
+        ...parseEnvConfig(env),
+        ...parseCliConfig(cli),
+    };
+    userConfig.disabledTools = commaSeparatedToArray(userConfig.disabledTools);
+    userConfig.loggers = commaSeparatedToArray(userConfig.loggers);
+    if (userConfig.connectionString && userConfig.connectionSpecifier) {
+        const connectionInfo = generateConnectionInfoFromCliArgs(userConfig);
+        userConfig.connectionString = connectionInfo.connectionString;
+    }
+    const transport = userConfig.transport;
+    if (transport !== "http" && transport !== "stdio") {
+        throw new Error(`Invalid transport: ${transport}`);
+    }
+    const telemetry = userConfig.telemetry;
+    if (telemetry !== "enabled" && telemetry !== "disabled") {
+        throw new Error(`Invalid telemetry: ${telemetry}`);
+    }
+    const httpPort = +userConfig.httpPort;
+    if (httpPort < 1 || httpPort > 65535 || isNaN(httpPort)) {
+        throw new Error(`Invalid httpPort: ${userConfig.httpPort}`);
+    }
+    if (userConfig.loggers.length === 0) {
+        throw new Error("No loggers found in config");
+    }
+    const loggerTypes = new Set(userConfig.loggers);
+    if (loggerTypes.size !== userConfig.loggers.length) {
+        throw new Error("Duplicate loggers found in config");
+    }
+    for (const loggerType of userConfig.loggers) {
+        if (loggerType !== "mcp" && loggerType !== "disk" && loggerType !== "stderr") {
+            throw new Error(`Invalid logger: ${loggerType}`);
+        }
+    }
+    registerKnownSecretsInRootKeychain(userConfig);
+    return userConfig;
+}
+export function setupDriverConfig({ config, defaults, }) {
+    const { driverOptions } = generateConnectionInfoFromCliArgs(config);
+    return {
+        ...defaults,
+        ...driverOptions,
+    };
+}
+//# sourceMappingURL=config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/common/config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,cAAc,CAAC;AAEhC,OAAO,EAAE,iCAAiC,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAEzC,4FAA4F;AAC5F,MAAM,OAAO,GAAG;IACZ,MAAM,EAAE;QACJ,YAAY;QACZ,aAAa;QACb,iBAAiB;QACjB,kBAAkB;QAClB,UAAU;QACV,UAAU;QACV,eAAe;QACf,SAAS;QACT,uBAAuB;QACvB,WAAW;QACX,WAAW;QACX,YAAY;QACZ,wBAAwB;QACxB,yBAAyB;QACzB,SAAS;QACT,IAAI;QACJ,gBAAgB;QAChB,mBAAmB;QACnB,MAAM;QACN,WAAW;QACX,iBAAiB;QACjB,UAAU;QACV,MAAM;QACN,WAAW;QACX,YAAY;QACZ,wBAAwB;QACxB,sBAAsB;QACtB,eAAe;QACf,mBAAmB;QACnB,8BAA8B;QAC9B,mBAAmB;QACnB,WAAW;QACX,YAAY;QACZ,uBAAuB;QACvB,+BAA+B;QAC/B,wBAAwB;QACxB,sBAAsB;QACtB,UAAU;KACb;IACD,OAAO,EAAE;QACL,sBAAsB;QACtB,WAAW;QACX,MAAM;QACN,YAAY;QACZ,MAAM;QACN,MAAM;QACN,0BAA0B;QAC1B,aAAa;QACb,qBAAqB;QACrB,UAAU;QACV,aAAa;QACb,KAAK;QACL,6BAA6B;QAC7B,0BAA0B;QAC1B,aAAa;QACb,KAAK;QACL,6BAA6B;QAC7B,0BAA0B;QAC1B,aAAa;QACb,SAAS;KACZ;IACD,KAAK,EAAE,CAAC,eAAe,EAAE,SAAS,CAAC;IACnC,KAAK,EAAE;QACH,CAAC,EAAE,MAAM;QACT,CAAC,EAAE,UAAU;QACb,CAAC,EAAE,UAAU;QACb,YAAY,EAAE,WAAW;QACzB,OAAO,EAAE,SAAS;QAClB,cAAc,EAAE,gBAAgB;QAChC,eAAe,EAAE,iBAAiB;QAClC,wBAAwB,EAAE,0BAA0B;KACvD;IACD,aAAa,EAAE;QACX,sBAAsB,EAAE,KAAK;QAC7B,yBAAyB,EAAE,IAAI;QAC/B,0BAA0B,EAAE,KAAK;QACjC,eAAe,EAAE,KAAK;QACtB,eAAe,EAAE,IAAI;QACrB,qBAAqB,EAAE,KAAK;KAC/B;CACK,CAAC;AAEX,MAAM,eAAe,GAAG,IAAI,GAAG,CAC1B,OAAO,CAAC,MAA4B;KAChC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;KACrB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;KACvB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAC1C,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAAC,GAAW;IACzC,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,IAAI,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC;IAC9B,IAAI,UAAU,GAAG,EAAE,CAAC;IAEpB,0CAA0C;IAC1C,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;QACrC,oDAAoD;QACpD,IAAI,QAAQ,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;YAC/C,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;QAClD,CAAC;QAED,oEAAoE;QACpE,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC3C,IAAI,GAAG,GAAG,MAAM,EAAE,CAAC;YACf,MAAM,GAAG,GAAG,CAAC;YACb,UAAU,GAAG,QAAQ,CAAC;QAC1B,CAAC;IACL,CAAC;IAED,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;QACd,uBAAuB;QACvB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;IACxC,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAuB;IAClD,OAAO,CACH,GAAG,KAAK,SAAS;QACjB,CAAC,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC;YACzB,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC;YAChC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAC1D,CAAC;AACN,CAAC;AA0BD,MAAM,CAAC,MAAM,iBAAiB,GAAe;IACzC,UAAU,EAAE,4BAA4B;IACxC,OAAO,EAAE,UAAU,EAAE;IACrB,WAAW,EAAE,cAAc,EAAE;IAC7B,eAAe,EAAE,MAAM,EAAE,YAAY;IACrC,uBAAuB,EAAE,MAAM,EAAE,YAAY;IAC7C,aAAa,EAAE,EAAE;IACjB,SAAS,EAAE,SAAS;IACpB,QAAQ,EAAE,KAAK;IACf,UAAU,EAAE,KAAK;IACjB,SAAS,EAAE,OAAO;IAClB,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,WAAW;IACrB,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;IACxB,aAAa,EAAE,MAAM,EAAE,aAAa;IACpC,qBAAqB,EAAE,MAAM,EAAE,YAAY;IAC3C,WAAW,EAAE,EAAE;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,eAAe,CAAC;IAClC,QAAQ,EAAE,iBAAiB;IAC3B,GAAG,EAAE,OAAO,CAAC,IAAI;IACjB,GAAG,EAAE,OAAO,CAAC,GAAG;CACnB,CAAC,CAAC;AAEH,SAAS,gBAAgB;IACrB,OAAO,OAAO,CAAC,QAAQ,KAAK,OAAO;QAC/B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,CAAC;QACvF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;AAC9C,CAAC;AAGD,MAAM,CAAC,MAAM,oBAAoB,GAAkB;IAC/C,WAAW,EAAE;QACT,KAAK,EAAE,OAAO;KACjB;IACD,cAAc,EAAE,oBAAoB;IACpC,YAAY,EAAE;QACV,CAAC,EAAE,UAAU;KAChB;IACD,SAAS,EAAE,KAAM;IACjB,KAAK,EAAE,EAAE,6BAA6B,EAAE,IAAI,EAAE;IAC9C,gBAAgB,EAAE,IAAI;CACzB,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,iBAAiB,CAAC;IAC3C,MAAM;IACN,QAAQ,EAAE,oBAAoB;CACjC,CAAC,CAAC;AAEH,SAAS,UAAU;IACf,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAC1E,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,SAAS,cAAc;IACnB,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;AACnE,CAAC;AAED,oFAAoF;AACpF,yFAAyF;AACzF,uBAAuB;AACvB,SAAS,cAAc,CAAC,GAA4B;IAChD,MAAM,gBAAgB,GAAgB,IAAI,GAAG,CAAqC,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAExG,SAAS,QAAQ,CAAC,GAA4B,EAAE,IAAc,EAAE,KAAa;QACzE,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,OAAO;QACX,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpB,IAAI,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;gBACrC,GAAG,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;gBAC1B,OAAO;YACX,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;gBACtB,GAAG,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC;gBAChC,OAAO;YACX,CAAC;YAED,MAAM,YAAY,GAAG,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC/C,IAAI,YAAY,KAAK,MAAM,IAAI,YAAY,KAAK,OAAO,EAAE,CAAC;gBACtD,GAAG,CAAC,YAAY,CAAC,GAAG,YAAY,KAAK,MAAM,CAAC;gBAC5C,OAAO;YACX,CAAC;YAED,kCAAkC;YAClC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC5B,GAAG,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC1D,OAAO;YACX,CAAC;YAED,GAAG,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;YAC1B,OAAO;QACX,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACrB,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QAC3B,CAAC;QAED,QAAQ,CAAC,GAAG,CAAC,YAAY,CAA4B,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAC3C,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAChD,CAAC;IACxB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,YAAY,EAAE,CAAC;QACtC,MAAM,SAAS,GAAG,GAAG;aAChB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;aACvB,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjD,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,sBAAsB,CAAC,GAAW;IACvC,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;AACtG,CAAC;AAED,uFAAuF;AACvF,mEAAmE;AACnE,+EAA+E;AAC/E,4EAA4E;AAC5E,0BAA0B;AAC1B,SAAS,cAAc,CAAC,IAAc;IAClC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,OAAkC,CAG9D,CAAC;IAEN,MAAM,mBAAmB,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IAE3C,qFAAqF;IACrF,oFAAoF;IACpF,mFAAmF;IACnF,2CAA2C;IAC3C,mCAAmC,CAC/B,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE,mBAAmB,EAAE,EACrC;QACI,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;QAChC,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;KACzC,CACJ,CAAC;IAEF,oEAAoE;IACpE,uEAAuE;IACvE,mEAAmE;IACnE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,qBAAqB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,MAAM,CAAC,mBAAmB,GAAG,mBAAmB,CAAC,KAAK,EAAE,CAAC;IAC7D,CAAC;IAED,OAAO,MAAM,CAAC,CAAC,CAAC;IAChB,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,mCAAmC,CAC/C,IAA6B,EAC7B,EAAE,IAAI,EAAE,IAAI,EAA2E;IAEvF,IAAI,sBAAsB,GAAG,KAAK,CAAC;IACnC,IAAI,mBAAmB,GAAG,KAAK,CAAC;IAEhC,MAAM,SAAS,GAAG,IAA0C,CAAC;IAC7D,6CAA6C;IAC7C,gEAAgE;IAChE,IAAI,SAAS,CAAC,gBAAgB,EAAE,CAAC;QAC7B,sBAAsB,GAAG,IAAI,CAAC;QAC9B,IAAI,CACA,4KAA4K,CAC/K,CAAC;IACN,CAAC;IAED,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1C,IAAI,WAAW,KAAK,GAAG,EAAE,CAAC;YACtB,sBAAsB;YACtB,SAAS;QACb,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAC7D,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,mBAAmB,GAAG,IAAI,CAAC;YAC3B,IAAI,UAAU,EAAE,CAAC;gBACb,IAAI,CAAC,kCAAkC,WAAW,oBAAoB,UAAU,IAAI,CAAC,CAAC;YAC1F,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,kCAAkC,WAAW,IAAI,CAAC,CAAC;YAC5D,CAAC;QACL,CAAC;IACL,CAAC;IAED,IAAI,mBAAmB,IAAI,sBAAsB,EAAE,CAAC;QAChD,IAAI,CAAC,8FAA8F,CAAC,CAAC;IACzG,CAAC;IAED,IAAI,mBAAmB,EAAE,CAAC;QACtB,IAAI,CAAC,CAAC,CAAC,CAAC;IACZ,CAAC;AACL,CAAC;AAED,SAAS,qBAAqB,CAAqB,GAAkC;IACjF,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACpB,OAAO,EAAkB,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CAAM,CAAC;IACtB,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,GAAQ,CAAC;IACpB,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,GAAG,CAAC,CAAC,CAAC;YACT,EAAE,KAAK,CAAC,GAAG,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAM,CAAC;IAC1C,CAAC;IAED,OAAO,GAAQ,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,UAA+B;IAC9E,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC;IAE/B,MAAM,aAAa,GAAG,CAAC,KAAyB,EAAE,IAAoB,EAAQ,EAAE;QAC5E,IAAI,KAAK,EAAE,CAAC;YACR,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC;IACL,CAAC,CAAC;IAEF,aAAa,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC9C,aAAa,CAAC,UAAU,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;IACtD,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;IACrD,aAAa,CAAC,UAAU,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;IACzD,aAAa,CAAC,UAAU,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;IACzD,aAAa,CAAC,UAAU,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;IACtD,aAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC/C,aAAa,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC3C,aAAa,CAAC,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC5C,aAAa,CAAC,UAAU,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;IACvD,aAAa,CAAC,UAAU,CAAC,6BAA6B,EAAE,UAAU,CAAC,CAAC;IACpE,aAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,EAC5B,GAAG,EACH,GAAG,EACH,QAAQ,GAKX;IACG,MAAM,UAAU,GAAe;QAC3B,GAAG,QAAQ;QACX,GAAG,cAAc,CAAC,GAAG,CAAC;QACtB,GAAG,cAAc,CAAC,GAAG,CAAC;KACX,CAAC;IAEhB,UAAU,CAAC,aAAa,GAAG,qBAAqB,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAC3E,UAAU,CAAC,OAAO,GAAG,qBAAqB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAE/D,IAAI,UAAU,CAAC,gBAAgB,IAAI,UAAU,CAAC,mBAAmB,EAAE,CAAC;QAChE,MAAM,cAAc,GAAG,iCAAiC,CAAC,UAAU,CAAC,CAAC;QACrE,UAAU,CAAC,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,CAAC;IAClE,CAAC;IAED,MAAM,SAAS,GAAG,UAAU,CAAC,SAAmB,CAAC;IACjD,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,SAAS,GAAG,UAAU,CAAC,SAAmB,CAAC;IACjD,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,QAAQ,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC;IACtC,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CAAC,qBAAqB,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAClD,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAChD,IAAI,WAAW,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,OAAmB,EAAE,CAAC;QACtD,IAAI,UAAU,KAAK,KAAK,IAAI,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC3E,MAAM,IAAI,KAAK,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;IACL,CAAC;IAED,kCAAkC,CAAC,UAAU,CAAC,CAAC;IAC/C,OAAO,UAAU,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,EAC9B,MAAM,EACN,QAAQ,GAIX;IACG,MAAM,EAAE,aAAa,EAAE,GAAG,iCAAiC,CAAC,MAAM,CAAC,CAAC;IACpE,OAAO;QACH,GAAG,QAAQ;QACX,GAAG,aAAa;KACnB,CAAC;AACN,CAAC"}

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

@@ -0,0 +1,18 @@
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { ErrorCodes, type MongoDBError } from "./errors.js";
+import type { AnyConnectionState } from "./connectionManager.js";
+import type { ToolBase } from "../tools/tool.js";
+export type ConnectionErrorHandler = (error: MongoDBError<ErrorCodes.NotConnectedToMongoDB | ErrorCodes.MisconfiguredConnectionString>, additionalContext: ConnectionErrorHandlerContext) => ConnectionErrorUnhandled | ConnectionErrorHandled;
+export type ConnectionErrorHandlerContext = {
+    availableTools: ToolBase[];
+    connectionState: AnyConnectionState;
+};
+export type ConnectionErrorUnhandled = {
+    errorHandled: false;
+};
+export type ConnectionErrorHandled = {
+    errorHandled: true;
+    result: CallToolResult;
+};
+export declare const connectionErrorHandler: ConnectionErrorHandler;
+//# sourceMappingURL=connectionErrorHandler.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connectionErrorHandler.d.ts","sourceRoot":"","sources":["../../../src/common/connectionErrorHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,MAAM,MAAM,sBAAsB,GAAG,CACjC,KAAK,EAAE,YAAY,CAAC,UAAU,CAAC,qBAAqB,GAAG,UAAU,CAAC,6BAA6B,CAAC,EAChG,iBAAiB,EAAE,6BAA6B,KAC/C,wBAAwB,GAAG,sBAAsB,CAAC;AAEvD,MAAM,MAAM,6BAA6B,GAAG;IAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;IAAC,eAAe,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAChH,MAAM,MAAM,wBAAwB,GAAG;IAAE,YAAY,EAAE,KAAK,CAAA;CAAE,CAAC;AAC/D,MAAM,MAAM,sBAAsB,GAAG;IAAE,YAAY,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,CAAC;AAEpF,eAAO,MAAM,sBAAsB,EAAE,sBAmEpC,CAAC"}

package/dist/esm/common/connectionErrorHandler.js

@@ -0,0 +1,66 @@
+import { ErrorCodes } from "./errors.js";
+export const connectionErrorHandler = (error, { availableTools, connectionState }) => {
+    const connectTools = availableTools
+        .filter((t) => t.operationType === "connect")
+        .sort((a, b) => a.category.localeCompare(b.category)); // Sort Atlas tools before MongoDB tools
+    // Find the first Atlas connect tool if available and suggest to the LLM to use it.
+    // Note: if we ever have multiple Atlas connect tools, we may want to refine this logic to select the most appropriate one.
+    const atlasConnectTool = connectTools?.find((t) => t.category === "atlas");
+    const llmConnectHint = atlasConnectTool
+        ? `Note to LLM: prefer using the "${atlasConnectTool.name}" tool to connect to an Atlas cluster over using a connection string. Make sure to ask the user to specify a cluster name they want to connect to or ask them if they want to use the "list-clusters" tool to list all their clusters. Do not invent cluster names or connection strings unless the user has explicitly specified them. If they've previously connected to MongoDB using MCP, you can ask them if they want to reconnect using the same cluster/connection.`
+        : "Note to LLM: do not invent connection strings and explicitly ask the user to provide one. If they have previously connected to MongoDB using MCP, you can ask them if they want to reconnect using the same connection string.";
+    const connectToolsNames = connectTools?.map((t) => `"${t.name}"`).join(", ");
+    const additionalPromptForConnectivity = [];
+    if (connectionState.tag === "connecting" && connectionState.oidcConnectionType) {
+        additionalPromptForConnectivity.push({
+            type: "text",
+            text: `The user needs to finish their OIDC connection by opening '${connectionState.oidcLoginUrl}' in the browser and use the following user code: '${connectionState.oidcUserCode}'`,
+        });
+    }
+    else {
+        additionalPromptForConnectivity.push({
+            type: "text",
+            text: connectToolsNames
+                ? `Please use one of the following tools: ${connectToolsNames} to connect to a MongoDB instance or update the MCP server configuration to include a connection string. ${llmConnectHint}`
+                : "There are no tools available to connect. Please update the configuration to include a connection string and restart the server.",
+        });
+    }
+    switch (error.code) {
+        case ErrorCodes.NotConnectedToMongoDB:
+            return {
+                errorHandled: true,
+                result: {
+                    content: [
+                        {
+                            type: "text",
+                            text: "You need to connect to a MongoDB instance before you can access its data.",
+                        },
+                        ...additionalPromptForConnectivity,
+                    ],
+                    isError: true,
+                },
+            };
+        case ErrorCodes.MisconfiguredConnectionString:
+            return {
+                errorHandled: true,
+                result: {
+                    content: [
+                        {
+                            type: "text",
+                            text: "The configured connection string is not valid. Please check the connection string and confirm it points to a valid MongoDB instance.",
+                        },
+                        {
+                            type: "text",
+                            text: connectTools
+                                ? `Alternatively, you can use one of the following tools: ${connectToolsNames} to connect to a MongoDB instance. ${llmConnectHint}`
+                                : "Please update the configuration to use a valid connection string and restart the server.",
+                        },
+                    ],
+                    isError: true,
+                },
+            };
+        default:
+            return { errorHandled: false };
+    }
+};
+//# sourceMappingURL=connectionErrorHandler.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connectionErrorHandler.js","sourceRoot":"","sources":["../../../src/common/connectionErrorHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAqB,MAAM,aAAa,CAAC;AAa5D,MAAM,CAAC,MAAM,sBAAsB,GAA2B,CAAC,KAAK,EAAE,EAAE,cAAc,EAAE,eAAe,EAAE,EAAE,EAAE;IACzG,MAAM,YAAY,GAAG,cAAc;SAC9B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,KAAK,SAAS,CAAC;SAC5C,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,wCAAwC;IAEnG,mFAAmF;IACnF,2HAA2H;IAC3H,MAAM,gBAAgB,GAAG,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;IAC3E,MAAM,cAAc,GAAG,gBAAgB;QACnC,CAAC,CAAC,kCAAkC,gBAAgB,CAAC,IAAI,6cAA6c;QACtgB,CAAC,CAAC,gOAAgO,CAAC;IAEvO,MAAM,iBAAiB,GAAG,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7E,MAAM,+BAA+B,GAAqC,EAAE,CAAC;IAE7E,IAAI,eAAe,CAAC,GAAG,KAAK,YAAY,IAAI,eAAe,CAAC,kBAAkB,EAAE,CAAC;QAC7E,+BAA+B,CAAC,IAAI,CAAC;YACjC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,8DAA8D,eAAe,CAAC,YAAY,sDAAsD,eAAe,CAAC,YAAY,GAAG;SACxL,CAAC,CAAC;IACP,CAAC;SAAM,CAAC;QACJ,+BAA+B,CAAC,IAAI,CAAC;YACjC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,iBAAiB;gBACnB,CAAC,CAAC,0CAA0C,iBAAiB,4GAA4G,cAAc,EAAE;gBACzL,CAAC,CAAC,iIAAiI;SAC1I,CAAC,CAAC;IACP,CAAC;IAED,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,UAAU,CAAC,qBAAqB;YACjC,OAAO;gBACH,YAAY,EAAE,IAAI;gBAClB,MAAM,EAAE;oBACJ,OAAO,EAAE;wBACL;4BACI,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,2EAA2E;yBACpF;wBACD,GAAG,+BAA+B;qBACrC;oBACD,OAAO,EAAE,IAAI;iBAChB;aACJ,CAAC;QACN,KAAK,UAAU,CAAC,6BAA6B;YACzC,OAAO;gBACH,YAAY,EAAE,IAAI;gBAClB,MAAM,EAAE;oBACJ,OAAO,EAAE;wBACL;4BACI,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,sIAAsI;yBAC/I;wBACD;4BACI,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,YAAY;gCACd,CAAC,CAAC,0DAA0D,iBAAiB,sCAAsC,cAAc,EAAE;gCACnI,CAAC,CAAC,0FAA0F;yBACnG;qBACJ;oBACD,OAAO,EAAE,IAAI;iBAChB;aACJ,CAAC;QAEN;YACI,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;IACvC,CAAC;AACL,CAAC,CAAC"}

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

@@ -0,0 +1,100 @@
+import { EventEmitter } from "events";
+import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
+import type { DeviceId } from "../helpers/deviceId.js";
+import { type DriverOptions, type UserConfig } from "./config.js";
+import { type LoggerBase } from "./logger.js";
+export interface AtlasClusterConnectionInfo {
+    username: string;
+    projectId: string;
+    clusterName: string;
+    expiryDate: Date;
+}
+export interface ConnectionSettings {
+    connectionString: string;
+    atlas?: AtlasClusterConnectionInfo;
+}
+type ConnectionTag = "connected" | "connecting" | "disconnected" | "errored";
+type OIDCConnectionAuthType = "oidc-auth-flow" | "oidc-device-flow";
+export type ConnectionStringAuthType = "scram" | "ldap" | "kerberos" | OIDCConnectionAuthType | "x.509";
+export interface ConnectionState {
+    tag: ConnectionTag;
+    connectionStringAuthType?: ConnectionStringAuthType;
+    connectedAtlasCluster?: AtlasClusterConnectionInfo;
+}
+export interface ConnectionStateConnected extends ConnectionState {
+    tag: "connected";
+    serviceProvider: NodeDriverServiceProvider;
+}
+export interface ConnectionStateConnecting extends ConnectionState {
+    tag: "connecting";
+    serviceProvider: NodeDriverServiceProvider;
+    oidcConnectionType: OIDCConnectionAuthType;
+    oidcLoginUrl?: string;
+    oidcUserCode?: string;
+}
+export interface ConnectionStateDisconnected extends ConnectionState {
+    tag: "disconnected";
+}
+export interface ConnectionStateErrored extends ConnectionState {
+    tag: "errored";
+    errorReason: string;
+}
+export type AnyConnectionState = ConnectionStateConnected | ConnectionStateConnecting | ConnectionStateDisconnected | ConnectionStateErrored;
+export interface ConnectionManagerEvents {
+    "connection-request": [AnyConnectionState];
+    "connection-success": [ConnectionStateConnected];
+    "connection-time-out": [ConnectionStateErrored];
+    "connection-close": [ConnectionStateDisconnected];
+    "connection-error": [ConnectionStateErrored];
+}
+/**
+ * For a few tests, we need the changeState method to force a connection state
+ * which is we have this type to typecast the actual ConnectionManager with
+ * public changeState (only to make TS happy).
+ */
+export type TestConnectionManager = ConnectionManager & {
+    changeState<Event extends keyof ConnectionManagerEvents, State extends ConnectionManagerEvents[Event][0]>(event: Event, newState: State): State;
+};
+export declare abstract class ConnectionManager {
+    protected clientName: string;
+    protected readonly _events: EventEmitter<ConnectionManagerEvents>;
+    readonly events: Pick<EventEmitter<ConnectionManagerEvents>, "on" | "off" | "once">;
+    private state;
+    constructor();
+    get currentConnectionState(): AnyConnectionState;
+    protected changeState<Event extends keyof ConnectionManagerEvents, State extends ConnectionManagerEvents[Event][0]>(event: Event, newState: State): State;
+    setClientName(clientName: string): void;
+    abstract connect(settings: ConnectionSettings): Promise<AnyConnectionState>;
+    abstract disconnect(): Promise<ConnectionStateDisconnected | ConnectionStateErrored>;
+}
+export declare class MCPConnectionManager extends ConnectionManager {
+    private userConfig;
+    private driverOptions;
+    private logger;
+    private deviceId;
+    private bus;
+    constructor(userConfig: UserConfig, driverOptions: DriverOptions, logger: LoggerBase, deviceId: DeviceId, bus?: EventEmitter);
+    connect(settings: ConnectionSettings): Promise<AnyConnectionState>;
+    disconnect(): Promise<ConnectionStateDisconnected | ConnectionStateErrored>;
+    private onOidcAuthFailed;
+    private onOidcAuthSucceeded;
+    private onOidcNotifyDeviceFlow;
+    static inferConnectionTypeFromSettings(config: UserConfig, settings: {
+        connectionString: string;
+    }): ConnectionStringAuthType;
+    private pingAndForget;
+    private disconnectOnOidcError;
+}
+/**
+ * Consumers of MCP server library have option to bring their own connection
+ * management if they need to. To support that, we enable injecting connection
+ * manager implementation through a factory function.
+ */
+export type ConnectionManagerFactoryFn = (createParams: {
+    logger: LoggerBase;
+    deviceId: DeviceId;
+    userConfig: UserConfig;
+}) => Promise<ConnectionManager>;
+export declare const createMCPConnectionManager: ConnectionManagerFactoryFn;
+export {};
+//# sourceMappingURL=connectionManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connectionManager.d.ts","sourceRoot":"","sources":["../../../src/common/connectionManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAElF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAA2C,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAE3G,OAAO,EAAE,KAAK,UAAU,EAAS,MAAM,aAAa,CAAC;AAIrD,MAAM,WAAW,0BAA0B;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IAC/B,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,0BAA0B,CAAC;CACtC;AAED,KAAK,aAAa,GAAG,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,SAAS,CAAC;AAC7E,KAAK,sBAAsB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;AACpE,MAAM,MAAM,wBAAwB,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,sBAAsB,GAAG,OAAO,CAAC;AAExG,MAAM,WAAW,eAAe;IAC5B,GAAG,EAAE,aAAa,CAAC;IACnB,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;IACpD,qBAAqB,CAAC,EAAE,0BAA0B,CAAC;CACtD;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC7D,GAAG,EAAE,WAAW,CAAC;IACjB,eAAe,EAAE,yBAAyB,CAAC;CAC9C;AAED,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAC9D,GAAG,EAAE,YAAY,CAAC;IAClB,eAAe,EAAE,yBAAyB,CAAC;IAC3C,kBAAkB,EAAE,sBAAsB,CAAC;IAC3C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,2BAA4B,SAAQ,eAAe;IAChE,GAAG,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC3D,GAAG,EAAE,SAAS,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,kBAAkB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,2BAA2B,GAC3B,sBAAsB,CAAC;AAE7B,MAAM,WAAW,uBAAuB;IACpC,oBAAoB,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAC3C,oBAAoB,EAAE,CAAC,wBAAwB,CAAC,CAAC;IACjD,qBAAqB,EAAE,CAAC,sBAAsB,CAAC,CAAC;IAChD,kBAAkB,EAAE,CAAC,2BAA2B,CAAC,CAAC;IAClD,kBAAkB,EAAE,CAAC,sBAAsB,CAAC,CAAC;CAChD;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG;IACpD,WAAW,CAAC,KAAK,SAAS,MAAM,uBAAuB,EAAE,KAAK,SAAS,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpG,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,KAAK,GAChB,KAAK,CAAC;CACZ,CAAC;AAEF,8BAAsB,iBAAiB;IACnC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,uBAAuB,CAAC,CAAC;IAClE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,EAAE,IAAI,GAAG,KAAK,GAAG,MAAM,CAAC,CAAC;IACpF,OAAO,CAAC,KAAK,CAAqB;;IAQlC,IAAI,sBAAsB,IAAI,kBAAkB,CAE/C;IAED,SAAS,CAAC,WAAW,CAAC,KAAK,SAAS,MAAM,uBAAuB,EAAE,KAAK,SAAS,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC9G,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,KAAK,GAChB,KAAK;IAQR,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAE3E,QAAQ,CAAC,UAAU,IAAI,OAAO,CAAC,2BAA2B,GAAG,sBAAsB,CAAC;CACvF;AAED,qBAAa,oBAAqB,SAAQ,iBAAiB;IAKnD,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,MAAM;IANlB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,GAAG,CAAe;gBAGd,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,UAAU,EAC1B,QAAQ,EAAE,QAAQ,EAClB,GAAG,CAAC,EAAE,YAAY;IAShB,OAAO,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAiGlE,UAAU,IAAI,OAAO,CAAC,2BAA2B,GAAG,sBAAsB,CAAC;IAkBjF,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,sBAAsB;IAqB9B,MAAM,CAAC,+BAA+B,CAClC,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE;QAAE,gBAAgB,EAAE,MAAM,CAAA;KAAE,GACvC,wBAAwB;YAiCb,aAAa;YAYb,qBAAqB;CAatC;AAED;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,YAAY,EAAE;IACpD,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;CAC1B,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEjC,eAAO,MAAM,0BAA0B,EAAE,0BAOxC,CAAC"}