@himanshusinghs/mongodb-mcp-server 1.5.1 → 1.7.0

package/dist/cjs/transports/interfaces/legacy.d.ts

@@ -0,0 +1,100 @@
+import type { UserConfig } from "../../common/config/userConfig.js";
+import type { ApiClientFactoryFn } from "../../common/atlas/apiClient.js";
+import type { AtlasLocalClientFactoryFn } from "../../common/atlasLocal.js";
+import type { ConnectionErrorHandler } from "../../common/connectionErrorHandler.js";
+import type { ConnectionManagerFactoryFn } from "../../common/connectionManager.js";
+import type { RunnerConfigCommonParameters } from "./common.js";
+export type RequestContext = {
+    headers?: Record<string, string | string[] | undefined>;
+    query?: Record<string, string | string[] | undefined>;
+};
+/**
+ * A function to dynamically generate `UserConfig` object, potentially unique to
+ * each MCP client session.
+ *
+ * The function is passed a config context object containing:
+ * 1. `userConfig`: The base `UserConfig` object that MongoDB MCP Server was
+ *    started with, either through parsed CLI arguments or a static
+ *    configuration injected through `TransportRunnerConfig`
+ * 2. `request`: An optional, `RequestContext` object, available only when
+ *    MongoDB MCP server is running over HTTP transport, that contains headers
+ *    and query parameters received in MCP session initialization object.
+ *
+ * @see {@link UserConfig} to inspect the properties available on `userConfig`
+ * object.
+ * @see {@link RequestContext} to inspect the properties available on
+ * `requestContext` object.
+ */
+export type CreateSessionConfigFn = (context: {
+    userConfig: UserConfig;
+    request?: RequestContext;
+}) => Promise<UserConfig> | UserConfig;
+/**
+ * Configuration options for customizing how transport runners are initialized.
+ * This includes specifying the base user configuration, providing custom
+ * connection management, and other advanced options.
+ *
+ * You may want to customize this configuration if you need to:
+ * - Provide a custom user configuration for different environments or users.
+ * - Override the default connection management to MongoDB deployments.
+ * - Provide a specific list of tools to be registered with the MCP server.
+ *
+ * In most cases, just providing the `UserConfig` object is sufficient, but
+ * advanced use-cases (such as embedding the MCP server in another application
+ * or supporting custom authentication flows) may require customizing other
+ * `TransportRunnerConfig` options as well.
+ */
+export type TransportRunnerConfigLegacy = RunnerConfigCommonParameters & {
+    /**
+     * An optional factory function to generates an instance of
+     * `ConnectionManager`. When not provided, MongoDB MCP Server uses an
+     * internal implementation to manage connection to MongoDB deployments.
+     *
+     * Customize this only if the use-case involves handling the MongoDB
+     * connections differently and outside of MongoDB MCP server.
+     */
+    createConnectionManager?: ConnectionManagerFactoryFn;
+    /**
+     * An optional function to handle connection related errors. When not
+     * provided, MongoDB MCP Server uses an internal implementation to handle
+     * the errors raised by internal implementation of `ConnectionManager`
+     * class.
+     *
+     * Customize this only if you need to handle the Connection errors different
+     * from the internal implementation or if you have provided a different
+     * implementation of `ConnectionManager` that might raise errors unknown to
+     * default internal connection error handler.
+     */
+    connectionErrorHandler?: ConnectionErrorHandler;
+    /**
+     * An optional factory function to create a client for working with Atlas
+     * local deployments. When not provided, MongoDB MCP Server uses an internal
+     * implementation to create the local Atlas client.
+     */
+    createAtlasLocalClient?: AtlasLocalClientFactoryFn;
+    /**
+     * An optional function to hook into session configuration lifecycle and
+     * provide session specific configuration (`UserConfig`).
+     *
+     * The function is called before each session is created, allowing you to:
+     * - Fetch configuration from external sources (secrets managers, APIs)
+     * - Apply user-specific permissions and limits
+     * - Modify connection strings dynamically
+     * - Validate authentication credentials
+     *
+     * This function is called for each new MCP client connection. For stdio
+     * transport, this is called once at server startup. For HTTP transport,
+     * this is called for each new session.
+     */
+    createSessionConfig?: CreateSessionConfigFn;
+    /**
+     * An optional factory function to generates an instance of
+     * `ApiClient`. When not provided, MongoDB MCP Server uses an
+     * internal implementation to create the API client.
+     *
+     * Customize this only if the use-case involves handling the API client
+     * differently and outside of MongoDB MCP server.
+     */
+    createApiClient?: ApiClientFactoryFn;
+};
+//# sourceMappingURL=legacy.d.ts.map

package/dist/cjs/transports/interfaces/legacy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy.d.ts","sourceRoot":"","sources":["../../../../src/transports/interfaces/legacy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AACrF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AACpF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAEhE,MAAM,MAAM,cAAc,GAAG;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE;IAC1C,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,cAAc,CAAC;CAC5B,KAAK,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC;AAEvC;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,2BAA2B,GAAG,4BAA4B,GAAG;IACrE;;;;;;;OAOG;IACH,uBAAuB,CAAC,EAAE,0BAA0B,CAAC;IAErD;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,yBAAyB,CAAC;IAEnD;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAC;IAE5C;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC;CACxC,CAAC"}

package/dist/cjs/transports/interfaces/legacy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=legacy.js.map

package/dist/cjs/transports/interfaces/legacy.js.map

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

package/dist/cjs/transports/interfaces/v1.d.ts

@@ -0,0 +1,6 @@
+import type { RunnerConfigCommonParameters } from "./common.js";
+export type TransportRunnerConfigV1 = RunnerConfigCommonParameters & {
+    schemaVersion: 1;
+    createSession(): void;
+};
+//# sourceMappingURL=v1.d.ts.map

package/dist/cjs/transports/interfaces/v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../../../src/transports/interfaces/v1.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAEhE,MAAM,MAAM,uBAAuB,GAAG,4BAA4B,GAAG;IACjE,aAAa,EAAE,CAAC,CAAC;IACjB,aAAa,IAAI,IAAI,CAAC;CACzB,CAAC"}

package/dist/cjs/transports/interfaces/v1.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=v1.js.map

package/dist/cjs/transports/interfaces/v1.js.map

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

package/dist/cjs/transports/runnerConfigs/commonConfig.d.ts

@@ -0,0 +1,85 @@
+import type { UserConfig } from "../../common/config/userConfig.js";
+import type { LoggerBase } from "../../common/logger.js";
+import type { CommonProperties } from "../../telemetry/types.js";
+import type { ToolClass } from "../../tools/tool.js";
+export type CommonTransportRunnerConfig = {
+    /**
+     * The config version of the runner config being provided. When
+     * configVersion is not provided or is `undefined`, the configuration is
+     * treated as legacy configuration.
+     */
+    configVersion?: undefined | number;
+    /**
+     * Base user configuration for the server.
+     *
+     * Can be generated by parsing CLI arguments, environment variables or
+     * written manually while conforming the interface requirements of
+     * `UserConfig`.
+     *
+     * To parse CLI arguments and environment variables in order to generate a
+     * `UserConfig` object, you can use `parseUserConfig` function, also
+     * exported as `parseUserConfig` through MCP server library
+     * exports.
+     *
+     * Optionally, you can also use `UserConfigSchema` (available through MCP
+     * server library exports) to create a default configuration -
+     * `UserConfigSchema.parse({})`.
+     */
+    userConfig: UserConfig;
+    /**
+     * An optional list of loggers to be used in addition to the default logger
+     * implementations. When not provided, MongoDB MCP Server will not utilize
+     * any loggers other than the default that it works with.
+     *
+     * Customize this only if the default enabled loggers (disk/stderr/mcp) are
+     * not covering your use-case.
+     */
+    additionalLoggers?: LoggerBase[];
+    /**
+     * An optional key value pair of telemetry properties that are reported to
+     * the telemetry backend. Most, if not all, of the properties are captured
+     * automatically.
+     */
+    telemetryProperties?: Partial<CommonProperties>;
+    /**
+     * An optional list of tools constructors to be registered to the MongoDB
+     * MCP Server.
+     *
+     * When not provided, MongoDB MCP Server will register all internal tools.
+     * When specified, **only** the tools in this list will be registered.
+     *
+     * This allows you to:
+     * - Register only custom tools (excluding all internal tools)
+     * - Register a subset of internal tools alongside custom tools
+     * - Register all internal tools plus custom tools
+     *
+     * To include internal tools, import them from `mongodb-mcp-server/tools`:
+     *
+     * ```typescript
+     * import { AllTools, AggregateTool, FindTool } from "mongodb-mcp-server/tools";
+     *
+     * // Register all internal tools plus custom tools
+     * tools: [...AllTools, MyCustomTool]
+     *
+     * // Register only specific MongoDB tools plus custom tools
+     * tools: [AggregateTool, FindTool, MyCustomTool]
+     *
+     * // Register all internal tools of mongodb category
+     * tools: [AllTools.filter((tool) => tool.category === "mongodb")]
+     * ```
+     *
+     * Note: Ensure that each tool has unique names otherwise the server will
+     * throw an error when initializing an MCP Client session. If you're using
+     * only the internal tools, then you don't have to worry about it unless,
+     * you've overridden the tool names.
+     *
+     * To ensure that you provide compliant tool implementations extend your
+     * tool implementation using `ToolBase` class and ensure that they conform
+     * to `ToolClass` type.
+     *
+     * @see {@link ToolClass} for the type that tool classes must conform to
+     * @see {@link ToolBase} for base class for all the tools
+     */
+    tools?: ToolClass[];
+};
+//# sourceMappingURL=commonConfig.d.ts.map

package/dist/cjs/transports/runnerConfigs/commonConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonConfig.d.ts","sourceRoot":"","sources":["../../../../src/transports/runnerConfigs/commonConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,MAAM,2BAA2B,GAAG;IACtC;;;;OAIG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IACnC;;;;;;;;;;;;;;;OAeG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;IAEjC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB,CAAC"}

package/dist/cjs/transports/runnerConfigs/commonConfig.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=commonConfig.js.map

package/dist/cjs/transports/runnerConfigs/commonConfig.js.map

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

package/dist/cjs/transports/runnerConfigs/index.d.ts

@@ -0,0 +1,6 @@
+import type { LegacyTransportRunnerConfig } from "./legacy.js";
+import type { V1TransportRunnerConfig } from "./v1.js";
+export type { LegacyTransportRunnerConfig, CreateSessionConfigFn, RequestContext } from "./legacy.js";
+export type { V1TransportRunnerConfig } from "./v1.js";
+export type TransportRunnerConfig = LegacyTransportRunnerConfig | V1TransportRunnerConfig;
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/transports/runnerConfigs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/transports/runnerConfigs/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAEvD,YAAY,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACtG,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AACvD,MAAM,MAAM,qBAAqB,GAAG,2BAA2B,GAAG,uBAAuB,CAAC"}

package/dist/cjs/transports/runnerConfigs/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/cjs/transports/runnerConfigs/index.js.map

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

package/dist/cjs/transports/runnerConfigs/legacy.d.ts

@@ -0,0 +1,100 @@
+import type { UserConfig } from "../../common/config/userConfig.js";
+import type { ApiClientFactoryFn } from "../../common/atlas/apiClient.js";
+import type { AtlasLocalClientFactoryFn } from "../../common/atlasLocal.js";
+import type { ConnectionErrorHandler } from "../../common/connectionErrorHandler.js";
+import type { ConnectionManagerFactoryFn } from "../../common/connectionManager.js";
+import type { CommonTransportRunnerConfig } from "./commonConfig.js";
+export type RequestContext = {
+    headers?: Record<string, string | string[] | undefined>;
+    query?: Record<string, string | string[] | undefined>;
+};
+/**
+ * A function to dynamically generate `UserConfig` object, potentially unique to
+ * each MCP client session.
+ *
+ * The function is passed a config context object containing:
+ * 1. `userConfig`: The base `UserConfig` object that MongoDB MCP Server was
+ *    started with, either through parsed CLI arguments or a static
+ *    configuration injected through `TransportRunnerConfig`
+ * 2. `request`: An optional, `RequestContext` object, available only when
+ *    MongoDB MCP server is running over HTTP transport, that contains headers
+ *    and query parameters received in MCP session initialization object.
+ *
+ * @see {@link UserConfig} to inspect the properties available on `userConfig`
+ * object.
+ * @see {@link RequestContext} to inspect the properties available on
+ * `requestContext` object.
+ */
+export type CreateSessionConfigFn = (context: {
+    userConfig: UserConfig;
+    request?: RequestContext;
+}) => Promise<UserConfig> | UserConfig;
+/**
+ * Configuration options for customizing how transport runners are initialized.
+ * This includes specifying the base user configuration, providing custom
+ * connection management, and other advanced options.
+ *
+ * You may want to customize this configuration if you need to:
+ * - Provide a custom user configuration for different environments or users.
+ * - Override the default connection management to MongoDB deployments.
+ * - Provide a specific list of tools to be registered with the MCP server.
+ *
+ * In most cases, just providing the `UserConfig` object is sufficient, but
+ * advanced use-cases (such as embedding the MCP server in another application
+ * or supporting custom authentication flows) may require customizing other
+ * `TransportRunnerConfig` options as well.
+ */
+export type LegacyTransportRunnerConfig = CommonTransportRunnerConfig & {
+    /**
+     * An optional factory function to generates an instance of
+     * `ConnectionManager`. When not provided, MongoDB MCP Server uses an
+     * internal implementation to manage connection to MongoDB deployments.
+     *
+     * Customize this only if the use-case involves handling the MongoDB
+     * connections differently and outside of MongoDB MCP server.
+     */
+    createConnectionManager?: ConnectionManagerFactoryFn;
+    /**
+     * An optional function to handle connection related errors. When not
+     * provided, MongoDB MCP Server uses an internal implementation to handle
+     * the errors raised by internal implementation of `ConnectionManager`
+     * class.
+     *
+     * Customize this only if you need to handle the Connection errors different
+     * from the internal implementation or if you have provided a different
+     * implementation of `ConnectionManager` that might raise errors unknown to
+     * default internal connection error handler.
+     */
+    connectionErrorHandler?: ConnectionErrorHandler;
+    /**
+     * An optional factory function to create a client for working with Atlas
+     * local deployments. When not provided, MongoDB MCP Server uses an internal
+     * implementation to create the local Atlas client.
+     */
+    createAtlasLocalClient?: AtlasLocalClientFactoryFn;
+    /**
+     * An optional function to hook into session configuration lifecycle and
+     * provide session specific configuration (`UserConfig`).
+     *
+     * The function is called before each session is created, allowing you to:
+     * - Fetch configuration from external sources (secrets managers, APIs)
+     * - Apply user-specific permissions and limits
+     * - Modify connection strings dynamically
+     * - Validate authentication credentials
+     *
+     * This function is called for each new MCP client connection. For stdio
+     * transport, this is called once at server startup. For HTTP transport,
+     * this is called for each new session.
+     */
+    createSessionConfig?: CreateSessionConfigFn;
+    /**
+     * An optional factory function to generates an instance of
+     * `ApiClient`. When not provided, MongoDB MCP Server uses an
+     * internal implementation to create the API client.
+     *
+     * Customize this only if the use-case involves handling the API client
+     * differently and outside of MongoDB MCP server.
+     */
+    createApiClient?: ApiClientFactoryFn;
+};
+//# sourceMappingURL=legacy.d.ts.map

package/dist/cjs/transports/runnerConfigs/legacy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy.d.ts","sourceRoot":"","sources":["../../../../src/transports/runnerConfigs/legacy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AACrF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AACpF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AAErE,MAAM,MAAM,cAAc,GAAG;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE;IAC1C,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,cAAc,CAAC;CAC5B,KAAK,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC;AAEvC;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,2BAA2B,GAAG,2BAA2B,GAAG;IACpE;;;;;;;OAOG;IACH,uBAAuB,CAAC,EAAE,0BAA0B,CAAC;IAErD;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,yBAAyB,CAAC;IAEnD;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAC;IAE5C;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC;CACxC,CAAC"}

package/dist/cjs/transports/runnerConfigs/legacy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=legacy.js.map

package/dist/cjs/transports/runnerConfigs/legacy.js.map

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

package/dist/cjs/transports/runnerConfigs/v1.d.ts

@@ -0,0 +1,22 @@
+import type { SessionOptions } from "../../common/session.js";
+import type { CompositeLogger } from "../../common/logger.js";
+import type { Keychain } from "../../common/keychain.js";
+import type { UserConfig } from "../../common/config/userConfig.js";
+import type { CommonTransportRunnerConfig } from "./commonConfig.js";
+import type { DeviceId } from "../../helpers/deviceId.js";
+import type { RequestContext } from "./legacy.js";
+export type BasicSessionOptions = {
+    userConfig: UserConfig;
+    logger: CompositeLogger;
+    keychain: Keychain;
+    deviceId: DeviceId;
+};
+export type V1TransportRunnerConfig = CommonTransportRunnerConfig & {
+    /**
+     * The config version of the runner config. Set it `1` to signal that you're
+     * providing the config compliant with V1 schema.
+     */
+    configVersion: 1;
+    overrideSessionOptions?(baseComponents: BasicSessionOptions, requestContext?: RequestContext): Promise<Partial<SessionOptions>>;
+};
+//# sourceMappingURL=v1.d.ts.map

package/dist/cjs/transports/runnerConfigs/v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../../../src/transports/runnerConfigs/v1.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,MAAM,mBAAmB,GAAG;IAC9B,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,eAAe,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,2BAA2B,GAAG;IAChE;;;OAGG;IACH,aAAa,EAAE,CAAC,CAAC;IAEjB,sBAAsB,CAAC,CACnB,cAAc,EAAE,mBAAmB,EACnC,cAAc,CAAC,EAAE,cAAc,GAChC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;CACvC,CAAC"}

package/dist/cjs/transports/runnerConfigs/v1.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=v1.js.map

package/dist/cjs/transports/runnerConfigs/v1.js.map

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

package/dist/cjs/transports/stdio.d.ts

@@ -1,8 +1,14 @@
+import type { CustomizableServerOptions } from "./base.js";
+import type { CustomizableSessionOptions } from "./base.js";
 import { TransportRunnerBase, type TransportRunnerConfig } from "./base.js";
-export declare class StdioRunner extends TransportRunnerBase {
+import type { UserConfig } from "../lib.js";
+export declare class StdioRunner<TUserConfig extends UserConfig = UserConfig, TContext = unknown> extends TransportRunnerBase<TUserConfig, TContext> {
     private server;
-    constructor(config: TransportRunnerConfig);
-    start(): Promise<void>;
+    constructor(config: TransportRunnerConfig<TUserConfig>);
+    start({ serverOptions, sessionOptions, }?: {
+        serverOptions?: CustomizableServerOptions<TUserConfig, TContext>;
+        sessionOptions?: CustomizableSessionOptions<TUserConfig>;
+    }): Promise<void>;
     closeTransport(): Promise<void>;
 }
 //# sourceMappingURL=stdio.d.ts.map

package/dist/cjs/transports/stdio.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stdio.d.ts","sourceRoot":"","sources":["../../../src/transports/stdio.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,KAAK,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAE5E,qBAAa,WAAY,SAAQ,mBAAmB;IAChD,OAAO,CAAC,MAAM,CAAqB;gBAEvB,MAAM,EAAE,qBAAqB;IAInC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBtB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAGxC"}
+{"version":3,"file":"stdio.d.ts","sourceRoot":"","sources":["../../../src/transports/stdio.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,KAAK,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,qBAAa,WAAW,CAAC,WAAW,SAAS,UAAU,GAAG,UAAU,EAAE,QAAQ,GAAG,OAAO,CAAE,SAAQ,mBAAmB,CACjH,WAAW,EACX,QAAQ,CACX;IACG,OAAO,CAAC,MAAM,CAA4C;gBAE9C,MAAM,EAAE,qBAAqB,CAAC,WAAW,CAAC;IAIhD,KAAK,CAAC,EACR,aAAa,EACb,cAAc,GACjB,GAAE;QACC,aAAa,CAAC,EAAE,yBAAyB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACjE,cAAc,CAAC,EAAE,0BAA0B,CAAC,WAAW,CAAC,CAAC;KACvD,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBhB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAGxC"}

package/dist/cjs/transports/stdio.js

@@ -8,9 +8,9 @@ class StdioRunner extends base_js_1.TransportRunnerBase {
     constructor(config) {
         super(config);
     }
-    async start() {
+    async start({ serverOptions, sessionOptions, } = {}) {
         try {
-            this.server = await this.setupServer();
+            this.server = await this.createServer({ serverOptions, sessionOptions });
             const transport = new stdio_js_1.StdioServerTransport();
             await this.server.connect(transport);
         }

package/dist/cjs/transports/stdio.js.map

@@ -1 +1 @@
-{"version":3,"file":"stdio.js","sourceRoot":"","sources":["../../../src/transports/stdio.ts"],"names":[],"mappings":";;;AAAA,wEAAiF;AACjF,mDAA4C;AAE5C,uCAA4E;AAE5E,MAAa,WAAY,SAAQ,6BAAmB;IAGhD,YAAY,MAA6B;QACrC,KAAK,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,SAAS,GAAG,IAAI,+BAAoB,EAAE,CAAC;YAE7C,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;gBAClB,EAAE,EAAE,iBAAK,CAAC,kBAAkB;gBAC5B,OAAO,EAAE,QAAQ;gBACjB,OAAO,EAAE,+BAA+B,KAAe,EAAE;aAC5D,CAAC,CAAC;YACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc;QAChB,MAAM,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;IAC/B,CAAC;CACJ;AA1BD,kCA0BC"}
+{"version":3,"file":"stdio.js","sourceRoot":"","sources":["../../../src/transports/stdio.ts"],"names":[],"mappings":";;;AAAA,wEAAiF;AACjF,mDAA4C;AAI5C,uCAA4E;AAG5E,MAAa,WAA6E,SAAQ,6BAGjG;IAGG,YAAY,MAA0C;QAClD,KAAK,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,EACR,aAAa,EACb,cAAc,MAId,EAAE;QACF,IAAI,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC,CAAC;YACzE,MAAM,SAAS,GAAG,IAAI,+BAAoB,EAAE,CAAC;YAE7C,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;gBAClB,EAAE,EAAE,iBAAK,CAAC,kBAAkB;gBAC5B,OAAO,EAAE,QAAQ;gBACjB,OAAO,EAAE,+BAA+B,KAAe,EAAE;aAC5D,CAAC,CAAC;YACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc;QAChB,MAAM,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;IAC/B,CAAC;CACJ;AAnCD,kCAmCC"}

package/dist/cjs/transports/streamableHttp.d.ts

@@ -1,12 +1,30 @@
-import { TransportRunnerBase, type TransportRunnerConfig } from "./base.js";
-export declare class StreamableHttpRunner extends TransportRunnerBase {
-    private httpServer;
-    private sessionStore;
-    constructor(config: TransportRunnerConfig);
-    get serverAddress(): string;
-    start(): Promise<void>;
+import { TransportRunnerBase, type TransportRunnerConfig, type RequestContext, type CustomizableSessionOptions } from "./base.js";
+import type { CustomizableServerOptions, Server, UserConfig } from "../lib.js";
+export declare class StreamableHttpRunner<TUserConfig extends UserConfig = UserConfig, TContext = unknown> extends TransportRunnerBase<TUserConfig, TContext> {
+    private mcpServer;
+    private healthCheckServer;
+    constructor(config: TransportRunnerConfig<TUserConfig>);
+    /** Starts the transport runner. */
+    start({ serverOptions, sessionOptions, }?: {
+        /** Server options to use when creating the server. */
+        serverOptions?: CustomizableServerOptions<TUserConfig, TContext>;
+        /** Session options to use when creating the session. */
+        sessionOptions?: CustomizableSessionOptions<TUserConfig>;
+    }): Promise<void>;
     closeTransport(): Promise<void>;
-    private withErrorHandling;
     private shouldWarnAboutHttpHost;
+    /**
+     * Creates a new MCP server instance for a given request.
+     */
+    protected createServerForRequest({ request, serverOptions, sessionOptions, }: {
+        request: RequestContext;
+        /** Upstream `serverOptions` passed from running `runner.start({ serverOptions })` method */
+        serverOptions?: CustomizableServerOptions<TUserConfig, TContext>;
+        /** Upstream `sessionOptions` passed from running `runner.start({ sessionOptions })` method */
+        sessionOptions?: CustomizableSessionOptions<TUserConfig>;
+    }): Promise<Server<TUserConfig, TContext>>;
+    private startMCPServer;
+    private startHealthCheckServer;
+    private validateConfig;
 }
 //# sourceMappingURL=streamableHttp.d.ts.map

package/dist/cjs/transports/streamableHttp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streamableHttp.d.ts","sourceRoot":"","sources":["../../../src/transports/streamableHttp.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,mBAAmB,EAAE,KAAK,qBAAqB,EAAuB,MAAM,WAAW,CAAC;AAWjG,qBAAa,oBAAqB,SAAQ,mBAAmB;IACzD,OAAO,CAAC,UAAU,CAA0B;IAC5C,OAAO,CAAC,YAAY,CAA+C;gBAEvD,MAAM,EAAE,qBAAqB;IAIzC,IAAW,aAAa,IAAI,MAAM,CAUjC;IAEK,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAwQtB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAerC,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,uBAAuB;CAKlC"}
+{"version":3,"file":"streamableHttp.d.ts","sourceRoot":"","sources":["../../../src/transports/streamableHttp.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,mBAAmB,EACnB,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,0BAA0B,EAClC,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAU/E,qBAAa,oBAAoB,CAC7B,WAAW,SAAS,UAAU,GAAG,UAAU,EAC3C,QAAQ,GAAG,OAAO,CACpB,SAAQ,mBAAmB,CAAC,WAAW,EAAE,QAAQ,CAAC;IAChD,OAAO,CAAC,SAAS,CAAmD;IACpE,OAAO,CAAC,iBAAiB,CAAgC;gBAE7C,MAAM,EAAE,qBAAqB,CAAC,WAAW,CAAC;IAItD,mCAAmC;IAC7B,KAAK,CAAC,EACR,aAAa,EACb,cAAc,GACjB,GAAE;QACC,sDAAsD;QACtD,aAAa,CAAC,EAAE,yBAAyB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACjE,wDAAwD;QACxD,cAAc,CAAC,EAAE,0BAA0B,CAAC,WAAW,CAAC,CAAC;KACvD,GAAG,OAAO,CAAC,IAAI,CAAC;IAahB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrC,OAAO,CAAC,uBAAuB;IAM/B;;OAEG;cACa,sBAAsB,CAAC,EACnC,OAAO,EACP,aAAa,EACb,cAAc,GACjB,EAAE;QACC,OAAO,EAAE,cAAc,CAAC;QACxB,4FAA4F;QAC5F,aAAa,CAAC,EAAE,yBAAyB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACjE,8FAA8F;QAC9F,cAAc,CAAC,EAAE,0BAA0B,CAAC,WAAW,CAAC,CAAC;KAC5D,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAgD5B,cAAc;YAgBd,sBAAsB;IASpC,OAAO,CAAC,cAAc;CAoBzB"}