fix bug with fetching deployment id caused by refactor

Author: jeroenvervaeke

src/tools/atlas/atlasTool.ts

@@ -82,6 +82,7 @@ For more information on Atlas API access roles, visit: https://www.mongodb.com/d
      * @returns The tool metadata
      */
     protected resolveTelemetryMetadata(
+        result: CallToolResult,
         ...args: Parameters<ToolCallback<typeof this.argsShape>>
     ): TelemetryToolMetadata {
         const toolMetadata: TelemetryToolMetadata = {};

src/tools/atlasLocal/atlasLocalTool.ts

@@ -6,6 +6,8 @@ import type { Client } from "@mongodb-js/atlas-local";
 import { LogId } from "../../common/logger.js";
 import { z } from "zod";
 
+export const AtlasLocalToolMetadataDeploymentIdKey = "deploymentId";
+
 export abstract class AtlasLocalToolBase extends ToolBase {
     public category: ToolCategory = "atlas-local";
 
@@ -39,10 +41,20 @@ please log a ticket here: https://github.com/mongodb-js/mongodb-mcp-server/issue
         return this.executeWithAtlasLocalClient(client, ...args);
     }
 
-    protected async lookupDeploymentId(client: Client, containerId: string): Promise<string> {
-        // Lookup and return the deployment id for telemetry metadata.
-        const deploymentId = await client.getDeploymentId(containerId);
-        return deploymentId;
+    protected async lookupDeploymentId(client: Client, containerId: string): Promise<string | undefined> {
+        try {
+            // Lookup and return the deployment id for telemetry metadata.
+            const deploymentId = await client.getDeploymentId(containerId);
+            return deploymentId;
+        } catch (error) {
+            this.session.logger.debug({
+                id: LogId.telemetryMetadataError,
+                context: "tool",
+                message: `Error looking up deployment ID: ${String(error)}`,
+            });
+
+            return undefined;
+        }
     }
 
     protected abstract executeWithAtlasLocalClient(
@@ -94,6 +106,7 @@ please log a ticket here: https://github.com/mongodb-js/mongodb-mcp-server/issue
     }
 
     protected async resolveTelemetryMetadata(
+        result: CallToolResult,
         ...args: Parameters<ToolCallback<typeof this.argsShape>>
     ): Promise<TelemetryToolMetadata> {
         const toolMetadata: TelemetryToolMetadata = {};
@@ -116,10 +129,20 @@ please log a ticket here: https://github.com/mongodb-js/mongodb-mcp-server/issue
             return toolMetadata;
         }
 
+        const resultDeploymentId = result._meta?.[AtlasLocalToolMetadataDeploymentIdKey];
+        if (resultDeploymentId !== undefined && typeof resultDeploymentId === "string") {
+            toolMetadata.atlasLocaldeploymentId = resultDeploymentId;
+        }
+
         const data = parsedResult.data;
 
         // Extract deploymentName using type guard and lookup deployment ID
-        if ("deploymentName" in data && typeof data.deploymentName === "string" && data.deploymentName.trim() !== "") {
+        if (
+            resultDeploymentId === undefined &&
+            "deploymentName" in data &&
+            typeof data.deploymentName === "string" &&
+            data.deploymentName.trim() !== ""
+        ) {
             const deploymentId = await this.lookupDeploymentId(client, data.deploymentName);
             toolMetadata.atlasLocaldeploymentId = deploymentId;
         }

src/tools/atlasLocal/create/createDeployment.ts

@@ -1,9 +1,8 @@
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { AtlasLocalToolBase } from "../atlasLocalTool.js";
-import type { OperationType, ToolArgs, TelemetryToolMetadata } from "../../tool.js";
+import { AtlasLocalToolBase, AtlasLocalToolMetadataDeploymentIdKey } 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 type { ToolCallback } from "@modelcontextprotocol/sdk/server/mcp.js";
 
 export class CreateDeploymentTool extends AtlasLocalToolBase {
     public name = "atlas-local-create-deployment";
@@ -13,8 +12,6 @@ export class CreateDeploymentTool extends AtlasLocalToolBase {
         deploymentName: CommonArgs.string().describe("Name of the deployment to create").optional(),
     };
 
-    private createdDeploymentId?: string;
-
     protected async executeWithAtlasLocalClient(
         client: Client,
         { deploymentName }: ToolArgs<typeof this.argsShape>
@@ -31,7 +28,7 @@ export class CreateDeploymentTool extends AtlasLocalToolBase {
         const deployment = await client.createDeployment(deploymentOptions);
 
         // Capture deployment ID for telemetry
-        this.createdDeploymentId = await this.lookupDeploymentId(client, deployment.containerId);
+        const createdDeploymentId = await this.lookupDeploymentId(client, deployment.containerId);
 
         return {
             content: [
@@ -40,17 +37,9 @@ export class CreateDeploymentTool extends AtlasLocalToolBase {
                     text: `Deployment with container ID "${deployment.containerId}" and name "${deployment.name}" created.`,
                 },
             ],
+            _meta: {
+                [AtlasLocalToolMetadataDeploymentIdKey]: createdDeploymentId,
+            },
         };
     }
-
-    // Create tool needs to override resolveTelemetryMetadata because it doesn't
-    // have the deployment name in the arguments, but rather in the response.
-    protected resolveTelemetryMetadata(
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        ...args: Parameters<ToolCallback<typeof this.argsShape>>
-    ): Promise<TelemetryToolMetadata> {
-        return Promise.resolve({
-            atlasLocaldeploymentId: this.createdDeploymentId,
-        });
-    }
 }

src/tools/atlasLocal/delete/deleteDeployment.ts

@@ -1,5 +1,5 @@
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { AtlasLocalToolBase } from "../atlasLocalTool.js";
+import { AtlasLocalToolBase, AtlasLocalToolMetadataDeploymentIdKey } from "../atlasLocalTool.js";
 import type { OperationType, ToolArgs } from "../../tool.js";
 import type { Client } from "@mongodb-js/atlas-local";
 import { CommonArgs } from "../../args.js";
@@ -16,11 +16,16 @@ export class DeleteDeploymentTool extends AtlasLocalToolBase {
         client: Client,
         { deploymentName }: ToolArgs<typeof this.argsShape>
     ): Promise<CallToolResult> {
+        const deploymentId = await this.lookupDeploymentId(client, deploymentName);
+
         // Delete the deployment
         await client.deleteDeployment(deploymentName);
 
         return {
             content: [{ type: "text", text: `Deployment "${deploymentName}" deleted successfully.` }],
+            _meta: {
+                [AtlasLocalToolMetadataDeploymentIdKey]: deploymentId,
+            },
         };
     }
 }

src/tools/mongodb/mongodbTool.ts

@@ -93,6 +93,8 @@ export abstract class MongoDBToolBase extends ToolBase {
     }
 
     protected resolveTelemetryMetadata(
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        result: CallToolResult,
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         args: ToolArgs<typeof this.argsShape>
     ): TelemetryToolMetadata {

src/tools/tool.ts

@@ -274,6 +274,7 @@ export abstract class ToolBase {
     }
 
     protected abstract resolveTelemetryMetadata(
+        result: CallToolResult,
         ...args: Parameters<ToolCallback<typeof this.argsShape>>
     ): TelemetryToolMetadata | Promise<TelemetryToolMetadata>;
 
@@ -292,7 +293,7 @@ export abstract class ToolBase {
             return;
         }
         const duration = Date.now() - startTime;
-        const metadata = await this.resolveTelemetryMetadata(...args);
+        const metadata = await this.resolveTelemetryMetadata(result, ...args);
         const event: ToolEvent = {
             timestamp: new Date().toISOString(),
             source: "mdbmcp",