feat: add structured content for response in atlas tools - MCP-374 (#1288)

Author: dudaschar

api-extractor/reports/tools.public.api.md

@@ -1,6 +1,5 @@
 import { z } from "zod";
-import { type OperationType, type ToolArgs, type ToolExecutionContext } from "../../tool.js";
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { type OperationType, type ToolArgs, type ToolExecutionContext, type ToolResult } from "../../tool.js";
 import { AtlasToolBase } from "../atlasTool.js";
 import { makeCurrentIpAccessListEntry, DEFAULT_ACCESS_LIST_COMMENT } from "../../../common/atlas/accessListUtils.js";
 import { AtlasArgs, CommonArgs } from "../../args.js";
@@ -16,18 +15,23 @@ export const CreateAccessListArgs = {
         .optional(),
 };
 
+const CreateAccessListOutputSchema = {
+    projectId: z.string(),
+};
+
 export class CreateAccessListTool extends AtlasToolBase {
     static toolName = "atlas-create-access-list";
     public description = "Allow Ip/CIDR ranges to access your MongoDB Atlas clusters.";
     static operationType: OperationType = "create";
     public argsShape = {
         ...CreateAccessListArgs,
     };
+    public override outputSchema = CreateAccessListOutputSchema;
 
     protected async execute(
         { projectId, ipAddresses, cidrBlocks, comment, currentIpAddress }: ToolArgs<typeof this.argsShape>,
         context: ToolExecutionContext
-    ): Promise<CallToolResult> {
+    ): Promise<ToolResult<typeof this.outputSchema>> {
         if (!ipAddresses?.length && !cidrBlocks?.length && !currentIpAddress) {
             throw new Error("One of  ipAddresses, cidrBlocks, currentIpAddress must be provided.");
         }
@@ -74,6 +78,9 @@ export class CreateAccessListTool extends AtlasToolBase {
                     text: `IP/CIDR ranges added to access list for project ${projectId}.`,
                 },
             ],
+            structuredContent: {
+                projectId,
+            },
         };
     }
 

src/tools/atlas/create/createAccessList.ts

@@ -1,6 +1,5 @@
 import { z } from "zod";
-import type { ToolArgs, OperationType, ToolExecutionContext } from "../../tool.js";
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { ToolArgs, OperationType, ToolExecutionContext, ToolResult } from "../../tool.js";
 import { AtlasToolBase } from "../atlasTool.js";
 import type { CloudDatabaseUser, DatabaseUserRole } from "../../../common/atlas/openapi.js";
 import { generateSecurePassword } from "../../../helpers/generatePassword.js";
@@ -14,7 +13,7 @@ export const CreateDBUserArgs = {
     // AtlasPassword123, which are easily guessable and exploitable. We're instructing
     // the model not to try and generate anything and instead leave the field unset.
     password: AtlasArgs.password()
-        .nullish()
+        .optional()
         .describe(
             "Password for the new user. IMPORTANT: If the user hasn't supplied an explicit password, leave it unset and under no circumstances try to generate a random one. A secure password will be generated by the MCP server if necessary."
         ),
@@ -33,18 +32,24 @@ export const CreateDBUserArgs = {
         .optional(),
 };
 
+const CreateDBUserOutputSchema = {
+    username: z.string(),
+    password: z.string().optional(),
+};
+
 export class CreateDBUserTool extends AtlasToolBase {
     static toolName = "atlas-create-db-user";
     public description = "Create an MongoDB Atlas database user";
     static operationType: OperationType = "create";
     public argsShape = {
         ...CreateDBUserArgs,
     };
+    public override outputSchema = CreateDBUserOutputSchema;
 
     protected async execute(
         { projectId, username, password, roles, clusters }: ToolArgs<typeof this.argsShape>,
         context: ToolExecutionContext
-    ): Promise<CallToolResult> {
+    ): Promise<ToolResult<typeof this.outputSchema>> {
         await ensureCurrentIpInAccessList(this.apiClient, projectId, context);
         const shouldGeneratePassword = !password;
         if (shouldGeneratePassword) {
@@ -93,6 +98,10 @@ export class CreateDBUserTool extends AtlasToolBase {
                     text: `User "${username}" created successfully${shouldGeneratePassword ? ` with password: \`${password}\`` : ""}.`,
                 },
             ],
+            structuredContent: {
+                username,
+                ...(shouldGeneratePassword && { password }),
+            },
         };
     }
 

src/tools/atlas/create/createDBUser.ts

@@ -1,10 +1,14 @@
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { type ToolArgs, type OperationType, type ToolExecutionContext } from "../../tool.js";
+import { z } from "zod";
+import { type ToolArgs, type OperationType, type ToolExecutionContext, type ToolResult } from "../../tool.js";
 import { AtlasToolBase } from "../atlasTool.js";
 import type { ClusterDescription20240805 } from "../../../common/atlas/openapi.js";
 import { ensureCurrentIpInAccessList } from "../../../common/atlas/accessListUtils.js";
 import { AtlasArgs } from "../../args.js";
 
+const CreateFreeClusterOutputSchema = {
+    created: z.boolean().describe("Whether the cluster was created successfully"),
+};
+
 export class CreateFreeClusterTool extends AtlasToolBase {
     static toolName = "atlas-create-free-cluster";
     public description = "Create a free MongoDB Atlas cluster";
@@ -14,11 +18,12 @@ export class CreateFreeClusterTool extends AtlasToolBase {
         name: AtlasArgs.clusterName().describe("Name of the cluster"),
         region: AtlasArgs.region().describe("Region of the cluster").default("US_EAST_1"),
     };
+    public override outputSchema = CreateFreeClusterOutputSchema;
 
     protected async execute(
         { projectId, name, region }: ToolArgs<typeof this.argsShape>,
         context: ToolExecutionContext
-    ): Promise<CallToolResult> {
+    ): Promise<ToolResult<typeof this.outputSchema>> {
         const input = {
             groupId: projectId,
             name,
@@ -59,6 +64,9 @@ export class CreateFreeClusterTool extends AtlasToolBase {
                 { type: "text", text: `Cluster "${name}" has been created in region "${region}".` },
                 { type: "text", text: `Double check your access lists to enable your current IP.` },
             ],
+            structuredContent: {
+                created: true,
+            },
         };
     }
 }

src/tools/atlas/create/createFreeCluster.ts

@@ -1,9 +1,14 @@
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { type OperationType, type ToolArgs, type ToolExecutionContext } from "../../tool.js";
+import { z } from "zod";
+import { type OperationType, type ToolArgs, type ToolExecutionContext, type ToolResult } from "../../tool.js";
 import { AtlasToolBase } from "../atlasTool.js";
 import type { Group } from "../../../common/atlas/openapi.js";
 import { AtlasArgs } from "../../args.js";
 
+const CreateProjectOutputSchema = {
+    projectName: z.string(),
+    organizationId: z.string().optional(),
+};
+
 export class CreateProjectTool extends AtlasToolBase {
     static toolName = "atlas-create-project";
     public description = "Create a MongoDB Atlas project";
@@ -12,11 +17,12 @@ export class CreateProjectTool extends AtlasToolBase {
         projectName: AtlasArgs.projectName().optional().describe("Name for the new project"),
         organizationId: AtlasArgs.organizationId().optional().describe("Organization ID for the new project"),
     };
+    public override outputSchema = CreateProjectOutputSchema;
 
     protected async execute(
         { projectName, organizationId }: ToolArgs<typeof this.argsShape>,
         context: ToolExecutionContext
-    ): Promise<CallToolResult> {
+    ): Promise<ToolResult<typeof this.outputSchema>> {
         let assumedOrg = false;
 
         if (!projectName) {
@@ -69,6 +75,10 @@ export class CreateProjectTool extends AtlasToolBase {
                     text: `Project "${projectName}" created successfully${assumedOrg ? ` (using organizationId ${organizationId}).` : ""}.`,
                 },
             ],
+            structuredContent: {
+                projectName,
+                ...(assumedOrg && { organizationId }),
+            },
         };
     }
 }