feat: add support for loading sample data to 'atlas-local-create-deployment' tool (#781)

Author: jeroenvervaeke

package.json

@@ -140,7 +140,7 @@
     "node": "^20.19.0 || ^22.12.0 || >= 23.0.0"
   },
   "optionalDependencies": {
-    "@mongodb-js/atlas-local": "^1.0.2",
+    "@mongodb-js/atlas-local": "^1.1.0",
     "kerberos": "^2.2.2"
   },
   "pnpm": {

pnpm-lock.yaml

@@ -3,17 +3,19 @@ import { AtlasLocalToolBase } from "../atlasLocalTool.js";
 import type { OperationType, ToolArgs } from "../../tool.js";
 import type { Client, CreateDeploymentOptions } from "@mongodb-js/atlas-local";
 import { CommonArgs } from "../../args.js";
+import z from "zod";
 
 export class CreateDeploymentTool extends AtlasLocalToolBase {
     public name = "atlas-local-create-deployment";
     protected description = "Create a MongoDB Atlas local deployment";
     static operationType: OperationType = "create";
     protected argsShape = {
         deploymentName: CommonArgs.string().describe("Name of the deployment to create").optional(),
+        loadSampleData: z.boolean().describe("Load sample data into the deployment").optional().default(false),
     };
 
     protected async executeWithAtlasLocalClient(
-        { deploymentName }: ToolArgs<typeof this.argsShape>,
+        { deploymentName, loadSampleData }: ToolArgs<typeof this.argsShape>,
         { client }: { client: Client }
     ): Promise<CallToolResult> {
         const deploymentOptions: CreateDeploymentOptions = {
@@ -22,6 +24,7 @@ export class CreateDeploymentTool extends AtlasLocalToolBase {
                 type: "MCPServer",
                 source: "MCPServer",
             },
+            loadSampleData,
             doNotTrack: !this.telemetry.isTelemetryEnabled(),
         };
         // Create the deployment

src/tools/atlasLocal/create/createDeployment.ts

@@ -79,4 +79,28 @@ describeAccuracyTests([
             },
         ],
     },
+    {
+        prompt: "Create a local MongoDB cluster named 'sample-cluster' with sample data",
+        expectedToolCalls: [
+            {
+                toolName: "atlas-local-create-deployment",
+                parameters: {
+                    deploymentName: "sample-cluster",
+                    loadSampleData: true,
+                },
+            },
+        ],
+    },
+    {
+        prompt: "Create a local MongoDB cluster named 'empty-cluster' without sample data",
+        expectedToolCalls: [
+            {
+                toolName: "atlas-local-create-deployment",
+                parameters: {
+                    deploymentName: "empty-cluster",
+                    loadSampleData: false,
+                },
+            },
+        ],
+    },
 ]);

tests/accuracy/createDeployment.test.ts

@@ -33,6 +33,7 @@ describeWithAtlasLocal("atlas-local-create-deployment", (integration) => {
         expect(createDeployment.inputSchema.type).toBe("object");
         expectDefined(createDeployment.inputSchema.properties);
         expect(createDeployment.inputSchema.properties).toHaveProperty("deploymentName");
+        expect(createDeployment.inputSchema.properties).toHaveProperty("loadSampleData");
     });
 
     it("should create a deployment when calling the tool", async () => {