Merge branch 'main' of github.com:mongodb-js/mongodb-mcp-server into gagik/query-header-override

Author: gagik

README.md

@@ -500,12 +500,12 @@ You can disable telemetry using:
 
 The MongoDB MCP Server may offer functionality that is still in development and may change in future releases. These features are considered "preview features" and are not enabled by default. Generally, these features are well tested, but may not offer the complete functionality we intend to provide in the final release or we'd like to gather feedback before making them generally available. To enable one or more preview features, use the `previewFeatures` configuration option.
 
-- For **environment variable** configuration, use a comma-separated string: `export MDB_MCP_PREVIEW_FEATURES="vectorSearch,feature1,feature2"`.
-- For **command-line argument** configuration, use a space-separated string: `--previewFeatures vectorSearch feature1 feature2`.
+- For **environment variable** configuration, use a comma-separated string: `export MDB_MCP_PREVIEW_FEATURES="search,feature1,feature2"`.
+- For **command-line argument** configuration, use a space-separated string: `--previewFeatures search feature1 feature2`.
 
 List of available preview features:
 
-- `vectorSearch` - Enables tools or functionality related to Vector Search in MongoDB Atlas:
+- `search` - Enables tools or functionality related to Atlas Search and Vector Search in MongoDB Atlas:
   - Index management, such as creating, listing, and dropping search and vector search indexes.
   - Querying collections using vector search capabilities. This requires a configured embedding model that will be used to generate vector representations of the query data. Currently, only [Voyage AI](https://www.voyageai.com) embedding models are supported. Set the `voyageApiKey` configuration option with your Voyage AI API key to use this feature.
 

package.json

@@ -66,10 +66,11 @@
     "generate": "pnpm run generate:api && pnpm run generate:arguments",
     "generate:api": "./scripts/generate.sh",
     "generate:arguments": "tsx scripts/generateArguments.ts",
+    "pretest": "pnpm run build",
     "test": "vitest --project eslint-rules --project unit-and-integration --coverage --run",
-    "pretest:accuracy": "pnpm run build",
     "test:accuracy": "sh ./scripts/accuracy/runAccuracyTests.sh",
     "test:long-running-tests": "vitest --project long-running-tests --coverage",
+    "test:local": "SKIP_ATLAS_TESTS=true SKIP_ATLAS_LOCAL_TESTS=true pnpm run test",
     "atlas:cleanup": "vitest --project atlas-cleanup"
   },
   "license": "Apache-2.0",

src/common/config/argsParserOptions.ts

@@ -60,6 +60,7 @@ export const OPTIONS = {
     boolean: [
         "apiDeprecationErrors",
         "apiStrict",
+        "dryRun",
         "embeddingsValidation",
         "help",
         "indexCheck",

src/common/config/createUserConfig.ts

@@ -170,19 +170,19 @@ function registerKnownSecretsInRootKeychain(userConfig: Partial<UserConfig>): vo
 }
 
 function warnIfVectorSearchNotEnabledCorrectly(config: UserConfig, warn: (message: string) => void): void {
-    const vectorSearchEnabled = config.previewFeatures.includes("vectorSearch");
+    const searchEnabled = config.previewFeatures.includes("search");
     const embeddingsProviderConfigured = !!config.voyageApiKey;
-    if (vectorSearchEnabled && !embeddingsProviderConfigured) {
+    if (searchEnabled && !embeddingsProviderConfigured) {
         warn(`\
 Warning: Vector search is enabled but no embeddings provider is configured.
 - Set an embeddings provider configuration option to enable auto-embeddings during document insertion and text-based queries with $vectorSearch.\
 `);
     }
 
-    if (!vectorSearchEnabled && embeddingsProviderConfigured) {
+    if (!searchEnabled && embeddingsProviderConfigured) {
         warn(`\
-Warning: An embeddings provider is configured but the 'vectorSearch' preview feature is not enabled.
-- Enable vector search by adding 'vectorSearch' to the 'previewFeatures' configuration option, or remove the embeddings provider configuration if not needed.\
+Warning: An embeddings provider is configured but the 'search' preview feature is not enabled.
+- Enable vector search by adding 'search' to the 'previewFeatures' configuration option, or remove the embeddings provider configuration if not needed.\
 `);
     }
 }

src/common/config/userConfig.ts

@@ -214,4 +214,11 @@ export const UserConfigSchema = z4.object({
             "When set to true, allows configuration values to be overridden via request headers and query parameters."
         )
         .register(configRegistry, { overrideBehavior: "not-allowed" }),
+    dryRun: z4
+        .boolean()
+        .default(false)
+        .describe(
+            "When true, runs the server in dry mode: dumps configuration and enabled tools, then exits without starting the server."
+        )
+        .register(configRegistry, { overrideBehavior: "not-allowed" }),
 });

src/common/schemas.ts

@@ -1,4 +1,4 @@
-export const previewFeatureValues = ["vectorSearch"] as const;
+export const previewFeatureValues = ["search"] as const;
 export type PreviewFeature = (typeof previewFeatureValues)[number];
 
 export const similarityValues = ["cosine", "euclidean", "dotProduct"] as const;

src/common/search/embeddingsProvider.ts

@@ -41,7 +41,7 @@ class VoyageEmbeddingsProvider implements EmbeddingsProvider<VoyageModels, Voyag
     }
 
     static isConfiguredIn({ voyageApiKey, previewFeatures }: UserConfig): boolean {
-        return previewFeatures.includes("vectorSearch") && !!voyageApiKey;
+        return previewFeatures.includes("search") && !!voyageApiKey;
     }
 
     async embed<Model extends VoyageModels>(

src/index.ts

@@ -44,13 +44,23 @@ import { StdioRunner } from "./transports/stdio.js";
 import { StreamableHttpRunner } from "./transports/streamableHttp.js";
 import { systemCA } from "@mongodb-js/devtools-proxy-support";
 import { Keychain } from "./common/keychain.js";
+import { DryRunModeRunner } from "./transports/dryModeRunner.js";
 
 async function main(): Promise<void> {
     systemCA().catch(() => undefined); // load system CA asynchronously as in mongosh
 
     const config = createUserConfig();
-    assertHelpMode(config);
-    assertVersionMode(config);
+    if (config.help) {
+        handleHelpRequest();
+    }
+
+    if (config.version) {
+        handleVersionRequest();
+    }
+
+    if (config.dryRun) {
+        await handleDryRunRequest(config);
+    }
 
     const transportRunner =
         config.transport === "stdio"
@@ -133,17 +143,35 @@ main().catch((error: unknown) => {
     process.exit(1);
 });
 
-function assertHelpMode(config: UserConfig): void | never {
-    if (config.help) {
-        console.log("For usage information refer to the README.md:");
-        console.log("https://github.com/mongodb-js/mongodb-mcp-server?tab=readme-ov-file#quick-start");
-        process.exit(0);
-    }
+function handleHelpRequest(): never {
+    console.log("For usage information refer to the README.md:");
+    console.log("https://github.com/mongodb-js/mongodb-mcp-server?tab=readme-ov-file#quick-start");
+    process.exit(0);
 }
 
-function assertVersionMode(config: UserConfig): void | never {
-    if (config.version) {
-        console.log(packageInfo.version);
+function handleVersionRequest(): never {
+    console.log(packageInfo.version);
+    process.exit(0);
+}
+
+export async function handleDryRunRequest(config: UserConfig): Promise<never> {
+    try {
+        const runner = new DryRunModeRunner({
+            userConfig: config,
+            logger: {
+                log(message): void {
+                    console.log(message);
+                },
+                error(message): void {
+                    console.error(message);
+                },
+            },
+        });
+        await runner.start();
+        await runner.close();
         process.exit(0);
+    } catch (error) {
+        console.error(`Fatal error running server in dry run mode: ${error as string}`);
+        process.exit(1);
     }
 }

src/tools/mongodb/create/createIndex.ts

@@ -76,11 +76,11 @@ export class CreateIndexTool extends MongoDBToolBase {
                         type: z.literal("classic"),
                         keys: z.object({}).catchall(z.custom<IndexDirection>()).describe("The index definition"),
                     }),
-                    ...(this.isFeatureEnabled("vectorSearch") ? [this.vectorSearchIndexDefinition] : []),
+                    ...(this.isFeatureEnabled("search") ? [this.vectorSearchIndexDefinition] : []),
                 ])
             )
             .describe(
-                `The index definition. Use 'classic' for standard indexes${this.isFeatureEnabled("vectorSearch") ? " and 'vectorSearch' for vector search indexes" : ""}.`
+                `The index definition. Use 'classic' for standard indexes${this.isFeatureEnabled("search") ? " and 'vectorSearch' for vector search indexes" : ""}.`
             ),
     };
 

src/tools/mongodb/create/insertMany.ts

@@ -25,7 +25,7 @@ export class InsertManyTool extends MongoDBToolBase {
             .describe(
                 "The array of documents to insert, matching the syntax of the document argument of db.collection.insertMany()."
             ),
-        ...(this.isFeatureEnabled("vectorSearch")
+        ...(this.isFeatureEnabled("search")
             ? {
                   embeddingParameters: zSupportedEmbeddingParametersWithInput
                       .optional()
@@ -45,7 +45,7 @@ export class InsertManyTool extends MongoDBToolBase {
     }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();
 
-        const embeddingParameters = this.isFeatureEnabled("vectorSearch")
+        const embeddingParameters = this.isFeatureEnabled("search")
             ? (providedEmbeddingParameters as z.infer<typeof zSupportedEmbeddingParametersWithInput>)
             : undefined;