feat: add structured content for response in atlas-local tools - MCP-374

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

@@ -30,9 +30,7 @@ import { z } from 'zod';
 import { ZodDefault } from 'zod';
 import { ZodOptional } from 'zod';
 import type { ZodRawShape } from 'zod';
-import { ZodRecord } from 'zod';
 import { ZodString } from 'zod';
-import { ZodUnknown } from 'zod';
 
 // @public (undocumented)
 export class AggregateDBTool extends MongoDBToolBase {
@@ -45,10 +43,20 @@ export class AggregateDBTool extends MongoDBToolBase {
     // (undocumented)
     description: string;
     // (undocumented)
-    protected execute(input: ToolArgs<typeof AggregateDBTool.argsShape>, input2: ToolExecutionContext): Promise<CallToolResult>;
+    protected execute(input: ToolArgs<typeof AggregateDBTool.argsShape>, input2: ToolExecutionContext): Promise<ToolResult<typeof AggregateDBTool.outputSchema>>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        documents: z.ZodArray<z.ZodUnknown>;
+        aggResultsCount: z.ZodOptional<z.ZodNumber>;
+        appliedLimits: z.ZodArray<z.ZodEnum<{
+            "config.maxDocumentsPerQuery": "config.maxDocumentsPerQuery";
+            "config.maxBytesPerQuery": "config.maxBytesPerQuery";
+            "tool.responseBytesLimit": "tool.responseBytesLimit";
+        }>>;
+    };
+    // (undocumented)
     static toolName: string;
 }
 
@@ -90,10 +98,20 @@ export class AggregateTool extends MongoDBToolBase {
     // (undocumented)
     description: string;
     // (undocumented)
-    protected execute(input: ToolArgs<typeof AggregateTool.argsShape>, input2: ToolExecutionContext): Promise<CallToolResult>;
+    protected execute(input: ToolArgs<typeof AggregateTool.argsShape>, input2: ToolExecutionContext): Promise<ToolResult<typeof AggregateTool.outputSchema>>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        documents: z.ZodArray<z.ZodUnknown>;
+        aggResultsCount: z.ZodOptional<z.ZodNumber>;
+        appliedLimits: z.ZodArray<z.ZodEnum<{
+            "config.maxDocumentsPerQuery": "config.maxDocumentsPerQuery";
+            "config.maxBytesPerQuery": "config.maxBytesPerQuery";
+            "tool.responseBytesLimit": "tool.responseBytesLimit";
+        }>>;
+    };
+    // (undocumented)
     static toolName: string;
 }
 
@@ -247,19 +265,24 @@ export class ConnectClusterTool extends AtlasToolBase {
 export class ConnectDeploymentTool extends AtlasLocalToolBase {
     // (undocumented)
     argsShape: {
-        deploymentName: ZodString;
+        deploymentName: z.ZodString;
     };
     // (undocumented)
     description: string;
     // (undocumented)
     protected executeWithAtlasLocalClient(input: ToolArgs<typeof ConnectDeploymentTool.argsShape>, input2: {
         client: Client;
-    }): Promise<CallToolResult>;
+    }): Promise<ToolResult<typeof ConnectDeploymentOutputSchema> & Pick<CallToolResult, "_meta">>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
-    protected resolveTelemetryMetadata(args: ToolArgs<typeof ConnectDeploymentTool.argsShape>, input: {
-        result: CallToolResult;
+    outputSchema: {
+        connected: z.ZodBoolean;
+        deploymentName: z.ZodString;
+    };
+    // (undocumented)
+    protected resolveTelemetryMetadata(_args: ToolArgs<typeof ConnectDeploymentTool.argsShape>, input: {
+        result: ToolResult<typeof ConnectDeploymentOutputSchema>;
     }): ConnectionMetadata;
     // (undocumented)
     static toolName: string;
@@ -275,10 +298,16 @@ export class ConnectTool extends MongoDBToolBase {
     // (undocumented)
     description: string;
     // (undocumented)
-    protected execute(input: ToolArgs<typeof ConnectTool.argsShape>): Promise<CallToolResult>;
+    protected execute(input: ToolArgs<typeof ConnectTool.argsShape>): Promise<ToolResult<typeof ConnectTool.outputSchema>>;
+    // (undocumented)
+    protected handleError(error: unknown, args: ToolArgs<typeof ConnectTool.argsShape>): Promise<CallToolResult>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        connected: z.ZodBoolean;
+    };
+    // (undocumented)
     register(server: Server): boolean;
     // (undocumented)
     static toolName: string;
@@ -288,17 +317,21 @@ export class ConnectTool extends MongoDBToolBase {
 export class CountTool extends MongoDBToolBase {
     // (undocumented)
     argsShape: {
-        query: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
-        collection: ZodString;
-        database: ZodString;
+        query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        collection: z.ZodString;
+        database: z.ZodString;
     };
     // (undocumented)
     description: string;
     // (undocumented)
-    protected execute(input: ToolArgs<typeof CountTool.argsShape>, input2: ToolExecutionContext): Promise<CallToolResult>;
+    protected execute(input: ToolArgs<typeof CountTool.argsShape>, input2: ToolExecutionContext): Promise<ToolResult<typeof CountTool.outputSchema>>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        count: z.ZodOptional<z.ZodNumber>;
+    };
+    // (undocumented)
     static toolName: string;
 }
 
@@ -480,10 +513,17 @@ export class CreateDeploymentTool extends AtlasLocalToolBase {
     // (undocumented)
     protected executeWithAtlasLocalClient(input: ToolArgs<typeof CreateDeploymentTool.argsShape>, input2: {
         client: Client;
-    }): Promise<CallToolResult>;
+    }): Promise<ToolResult<typeof CreateDeploymentOutputSchema> & Pick<CallToolResult, "_meta">>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        deploymentName: z.ZodString;
+        containerId: z.ZodString;
+        loadSampleData: z.ZodBoolean;
+        imageTag: z.ZodString;
+    };
+    // (undocumented)
     static toolName: string;
 }
 
@@ -643,17 +683,22 @@ export class DbStatsTool extends MongoDBToolBase {
 export class DeleteDeploymentTool extends AtlasLocalToolBase {
     // (undocumented)
     argsShape: {
-        deploymentName: ZodString;
+        deploymentName: z.ZodString;
     };
     // (undocumented)
     description: string;
     // (undocumented)
     protected executeWithAtlasLocalClient(input: ToolArgs<typeof DeleteDeploymentTool.argsShape>, input2: {
         client: Client;
-    }): Promise<CallToolResult>;
+    }): Promise<ToolResult<typeof DeleteDeploymentOutputSchema> & Pick<CallToolResult, "_meta">>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        deleted: z.ZodBoolean;
+        deploymentName: z.ZodString;
+    };
+    // (undocumented)
     static toolName: string;
 }
 
@@ -919,10 +964,18 @@ export class ExportTool extends MongoDBToolBase {
     // (undocumented)
     description: string;
     // (undocumented)
-    protected execute(input: ToolArgs<typeof ExportTool.argsShape>, input2: ToolExecutionContext): Promise<CallToolResult>;
+    protected execute(input: ToolArgs<typeof ExportTool.argsShape>, input2: ToolExecutionContext): Promise<ToolResult<typeof ExportTool.outputSchema>>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        type: z.ZodLiteral<"resource_link">;
+        name: z.ZodString;
+        uri: z.ZodString;
+        description: z.ZodString;
+        mimeType: z.ZodString;
+    };
+    // (undocumented)
     static toolName: string;
 }
 
@@ -943,10 +996,20 @@ export class FindTool extends MongoDBToolBase {
     // (undocumented)
     description: string;
     // (undocumented)
-    protected execute(input: ToolArgs<typeof FindTool.argsShape>, input2: ToolExecutionContext): Promise<CallToolResult>;
+    protected execute(input: ToolArgs<typeof FindTool.argsShape>, input2: ToolExecutionContext): Promise<ToolResult<typeof FindTool.outputSchema>>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        documents: z.ZodArray<z.ZodUnknown>;
+        queryResultsCount: z.ZodOptional<z.ZodNumber>;
+        appliedLimits: z.ZodArray<z.ZodEnum<{
+            "config.maxDocumentsPerQuery": "config.maxDocumentsPerQuery";
+            "config.maxBytesPerQuery": "config.maxBytesPerQuery";
+            "tool.responseBytesLimit": "tool.responseBytesLimit";
+        }>>;
+    };
+    // (undocumented)
     static toolName: string;
 }
 
@@ -1155,10 +1218,19 @@ export class ListDeploymentsTool extends AtlasLocalToolBase {
     // (undocumented)
     protected executeWithAtlasLocalClient(_args: ToolArgs<typeof ListDeploymentsTool.argsShape>, input: {
         client: Client;
-    }): Promise<CallToolResult>;
+    }): Promise<ToolResult<typeof ListDeploymentsOutputSchema>>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        count: z.ZodNumber;
+        deployments: z.ZodArray<z.ZodObject<{
+            name: z.ZodOptional<z.ZodString>;
+            state: z.ZodString;
+            mongodbVersion: z.ZodString;
+        }, z.core.$strip>>;
+    };
+    // (undocumented)
     static toolName: string;
 }
 
@@ -1685,10 +1757,16 @@ export class SwitchConnectionTool extends MongoDBToolBase {
     // (undocumented)
     description: string;
     // (undocumented)
-    protected execute(input: ToolArgs<typeof SwitchConnectionTool.argsShape>): Promise<CallToolResult>;
+    protected execute(input: ToolArgs<typeof SwitchConnectionTool.argsShape>): Promise<ToolResult<typeof SwitchConnectionTool.outputSchema>>;
+    // (undocumented)
+    protected handleError(error: unknown, args: ToolArgs<typeof SwitchConnectionTool.argsShape>): Promise<CallToolResult>;
     // (undocumented)
     static operationType: OperationType;
     // (undocumented)
+    outputSchema: {
+        connected: z.ZodBoolean;
+    };
+    // (undocumented)
     register(server: Server): boolean;
     // (undocumented)
     static toolName: string;
@@ -1778,10 +1856,7 @@ export interface ToolExecutionContext {
 
 // @public (undocumented)
 export type ToolResult<OutputSchema extends ZodRawShape | undefined = undefined> = OutputSchema extends ZodRawShape ? StructuredToolResult<OutputSchema> : {
-    content: {
-        type: "text";
-        text: string;
-    }[];
+    content: CallToolResult["content"];
     isError?: boolean;
 };
 

package.json

@@ -177,6 +177,7 @@
     "bson": "^7.2.0",
     "chalk": "^5.6.2",
     "express": "^5.2.1",
+    "hadron-document": "^8.11.5",
     "jsonc-parser": "^3.3.1",
     "lru-cache": "^11.2.6",
     "mongodb": "^7.1.1",

src/helpers/bsonToJson.ts

@@ -0,0 +1,19 @@
+import { objectToIdiomaticEJSON } from "hadron-document";
+
+/**
+ * Converts a BSON value into a JSON-safe object using Compass idiomatic Extended JSON.
+ *
+ * ObjectId becomes `{ "$oid": "..." }`, Long becomes `{ "$numberLong": "..." }`, etc.
+ */
+export function bsonToJson(value: Record<string, unknown>): Record<string, unknown>;
+export function bsonToJson(value: unknown): unknown;
+export function bsonToJson(value: unknown): unknown {
+    return JSON.parse(objectToIdiomaticEJSON(value));
+}
+
+/**
+ * Serializes an array of BSON objects.
+ */
+export function serializeBsonToJsonObjects(objects: unknown[]): unknown[] {
+    return objects.map((object) => bsonToJson(object));
+}