@himanshusinghs/mongodb-mcp-server 1.5.1 → 1.7.0

package/dist/esm/tools/mongodb/metadata/collectionIndexes.d.ts

@@ -1,23 +1,92 @@
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
-import type { ToolArgs, OperationType } from "../../tool.js";
-import type { Document } from "bson";
+import type { ToolArgs, OperationType, ToolResult } from "../../tool.js";
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+declare const CollectionIndexesOutputSchema: {
+    classicIndexes: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        key: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        key: Record<string, unknown>;
+    }, {
+        name: string;
+        key: Record<string, unknown>;
+    }>, "many">;
+    searchIndexes: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodString;
+        status: z.ZodString;
+        queryable: z.ZodBoolean;
+        latestDefinition: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name: string;
+        status: string;
+        latestDefinition: Record<string, unknown>;
+        queryable: boolean;
+    }, {
+        type: string;
+        name: string;
+        status: string;
+        latestDefinition: Record<string, unknown>;
+        queryable: boolean;
+    }>, "many">;
+    classicIndexesCount: z.ZodNumber;
+    searchIndexesCount: z.ZodNumber;
+};
+export type CollectionIndexesOutput = z.infer<z.ZodObject<typeof CollectionIndexesOutputSchema>>;
+type SearchIndexStatus = CollectionIndexesOutput["searchIndexes"][number];
 export declare class CollectionIndexesTool extends MongoDBToolBase {
-    name: string;
+    static toolName: string;
     description: string;
     argsShape: {
-        database: import("zod").ZodString;
-        collection: import("zod").ZodString;
+        database: z.ZodString;
+        collection: z.ZodString;
+    };
+    outputSchema: {
+        classicIndexes: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            key: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            key: Record<string, unknown>;
+        }, {
+            name: string;
+            key: Record<string, unknown>;
+        }>, "many">;
+        searchIndexes: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            type: z.ZodString;
+            status: z.ZodString;
+            queryable: z.ZodBoolean;
+            latestDefinition: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            type: string;
+            name: string;
+            status: string;
+            latestDefinition: Record<string, unknown>;
+            queryable: boolean;
+        }, {
+            type: string;
+            name: string;
+            status: string;
+            latestDefinition: Record<string, unknown>;
+            queryable: boolean;
+        }>, "many">;
+        classicIndexesCount: z.ZodNumber;
+        searchIndexesCount: z.ZodNumber;
     };
     static operationType: OperationType;
-    protected execute({ database, collection }: ToolArgs<typeof DbOperationArgs>): Promise<CallToolResult>;
-    protected handleError(error: unknown, args: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> | CallToolResult;
+    protected execute({ database, collection, }: ToolArgs<typeof DbOperationArgs>): Promise<ToolResult<typeof this.outputSchema>>;
+    protected handleError(error: unknown, args: ToolArgs<typeof this.argsShape>): Promise<CallToolResult>;
     /**
      * Atlas Search index status contains a lot of information that is not relevant for the agent at this stage.
      * Like for example, the status on each of the dedicated nodes. We only care about the main status, if it's
      * queryable and the index name. We are also picking the index definition as it can be used by the agent to
      * understand which fields are available for searching.
      **/
-    protected extractSearchIndexDetails(indexes: Record<string, unknown>[]): Document[];
+    protected extractSearchIndexDetails(indexes: Record<string, unknown>[]): SearchIndexStatus[];
 }
+export {};
 //# sourceMappingURL=collectionIndexes.d.ts.map

package/dist/esm/tools/mongodb/metadata/collectionIndexes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collectionIndexes.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionIndexes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE7D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAOrC,qBAAa,qBAAsB,SAAQ,eAAe;IAC/C,IAAI,SAAwB;IAC5B,WAAW,SAA2C;IACtD,SAAS;;;MAAmB;IACnC,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,QAAQ,CAAC,OAAO,eAAe,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IA8B5G,SAAS,CAAC,WAAW,CACjB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,GACtC,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc;IAgB3C;;;;;QAKI;IACJ,SAAS,CAAC,yBAAyB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,QAAQ,EAAE;CAuBtF"}
+{"version":3,"file":"collectionIndexes.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionIndexes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEzE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEzE,QAAA,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkBlC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,6BAA6B,CAAC,CAAC,CAAC;AAEjG,KAAK,iBAAiB,GAAG,uBAAuB,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAG1E,qBAAa,qBAAsB,SAAQ,eAAe;IACtD,MAAM,CAAC,QAAQ,SAAwB;IAChC,WAAW,SAA2C;IACtD,SAAS;;;MAAmB;IACnB,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAiC;IAC7D,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CAAC,EACpB,QAAQ,EACR,UAAU,GACb,EAAE,QAAQ,CAAC,OAAO,eAAe,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;cAoCnE,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAiB3G;;;;;QAKI;IACJ,SAAS,CAAC,yBAAyB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,iBAAiB,EAAE;CAS/F"}

package/dist/esm/tools/mongodb/metadata/collectionIndexes.js

@@ -1,34 +1,57 @@
 import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { formatUntrustedData } from "../../tool.js";
+import { z } from "zod";
+const CollectionIndexesOutputSchema = {
+    classicIndexes: z.array(z.object({
+        name: z.string(),
+        key: z.record(z.unknown()),
+    })),
+    searchIndexes: z.array(z.object({
+        name: z.string(),
+        type: z.string(),
+        status: z.string(),
+        queryable: z.boolean(),
+        latestDefinition: z.record(z.unknown()),
+    })),
+    classicIndexesCount: z.number(),
+    searchIndexesCount: z.number(),
+};
 export class CollectionIndexesTool extends MongoDBToolBase {
     constructor() {
         super(...arguments);
-        this.name = "collection-indexes";
         this.description = "Describe the indexes for a collection";
         this.argsShape = DbOperationArgs;
+        this.outputSchema = CollectionIndexesOutputSchema;
     }
-    async execute({ database, collection }) {
+    async execute({ database, collection, }) {
         const provider = await this.ensureConnected();
         const indexes = await provider.getIndexes(database, collection);
-        const indexDefinitions = indexes.map((index) => ({
+        const classicIndexes = indexes.map((index) => ({
             name: index.name,
             key: index.key,
         }));
-        const searchIndexDefinitions = [];
+        const searchIndexes = [];
         if (this.isFeatureEnabled("search") && (await this.session.isSearchSupported())) {
-            const searchIndexes = await provider.getSearchIndexes(database, collection);
-            searchIndexDefinitions.push(...this.extractSearchIndexDetails(searchIndexes));
+            const searchIndexDefinitions = await provider.getSearchIndexes(database, collection);
+            searchIndexes.push(...this.extractSearchIndexDetails(searchIndexDefinitions));
         }
         return {
             content: [
-                ...formatUntrustedData(`Found ${indexDefinitions.length} classic indexes in the collection "${collection}":`, ...indexDefinitions.map((i) => JSON.stringify(i))),
-                ...(searchIndexDefinitions.length > 0
-                    ? formatUntrustedData(`Found ${searchIndexDefinitions.length} search and vector search indexes in the collection "${collection}":`, ...searchIndexDefinitions.map((i) => JSON.stringify(i)))
+                ...formatUntrustedData(`Found ${classicIndexes.length} classic indexes in the collection "${collection}":`, JSON.stringify(classicIndexes)),
+                ...(searchIndexes.length > 0
+                    ? formatUntrustedData(`Found ${searchIndexes.length} search and vector search indexes in the collection "${collection}":`, JSON.stringify(searchIndexes))
                     : []),
             ],
+            structuredContent: {
+                classicIndexes,
+                searchIndexes,
+                classicIndexesCount: classicIndexes.length,
+                searchIndexesCount: searchIndexes.length,
+            },
         };
     }
-    handleError(error, args) {
+    async handleError(error, args) {
+        // >>>>>>> main
         if (error instanceof Error && "codeName" in error && error.codeName === "NamespaceNotFound") {
             return {
                 content: [
@@ -49,26 +72,15 @@ export class CollectionIndexesTool extends MongoDBToolBase {
      * understand which fields are available for searching.
      **/
     extractSearchIndexDetails(indexes) {
-        return indexes.map((index) => {
-            const result = {};
-            if (index["name"] !== undefined) {
-                result.name = index["name"];
-            }
-            if (index["type"] !== undefined) {
-                result.type = index["type"];
-            }
-            if (index["status"] !== undefined) {
-                result.status = index["status"];
-            }
-            if (index["queryable"] !== undefined) {
-                result.queryable = index["queryable"];
-            }
-            if (index["latestDefinition"] !== undefined) {
-                result.latestDefinition = index["latestDefinition"];
-            }
-            return result;
-        });
+        return indexes.map((index) => ({
+            name: (index["name"] ?? "default"),
+            type: (index["type"] ?? "UNKNOWN"),
+            status: (index["status"] ?? "UNKNOWN"),
+            queryable: (index["queryable"] ?? false),
+            latestDefinition: (index["latestDefinition"] ?? {}),
+        }));
     }
 }
+CollectionIndexesTool.toolName = "collection-indexes";
 CollectionIndexesTool.operationType = "metadata";
 //# sourceMappingURL=collectionIndexes.js.map

package/dist/esm/tools/mongodb/metadata/collectionIndexes.js.map

@@ -1 +1 @@
-{"version":3,"file":"collectionIndexes.js","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionIndexes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAQpD,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IAA1D;;QACW,SAAI,GAAG,oBAAoB,CAAC;QAC5B,gBAAW,GAAG,uCAAuC,CAAC;QACtD,cAAS,GAAG,eAAe,CAAC;IAiFvC,CAAC;IA9Ea,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAoC;QAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAChE,MAAM,gBAAgB,GAAkB,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC5D,IAAI,EAAE,KAAK,CAAC,IAAc;YAC1B,GAAG,EAAE,KAAK,CAAC,GAAe;SAC7B,CAAC,CAAC,CAAC;QAEJ,MAAM,sBAAsB,GAAe,EAAE,CAAC;QAC9C,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;YAC9E,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YAC5E,sBAAsB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC,CAAC;QAClF,CAAC;QAED,OAAO;YACH,OAAO,EAAE;gBACL,GAAG,mBAAmB,CAClB,SAAS,gBAAgB,CAAC,MAAM,uCAAuC,UAAU,IAAI,EACrF,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CACpD;gBACD,GAAG,CAAC,sBAAsB,CAAC,MAAM,GAAG,CAAC;oBACjC,CAAC,CAAC,mBAAmB,CACf,SAAS,sBAAsB,CAAC,MAAM,wDAAwD,UAAU,IAAI,EAC5G,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAC1D;oBACH,CAAC,CAAC,EAAE,CAAC;aACZ;SACJ,CAAC;IACN,CAAC;IAES,WAAW,CACjB,KAAc,EACd,IAAqC;QAErC,IAAI,KAAK,YAAY,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,KAAK,mBAAmB,EAAE,CAAC;YAC1F,OAAO;gBACH,OAAO,EAAE;oBACL;wBACI,IAAI,EAAE,oBAAoB,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,+DAA+D;wBACzH,IAAI,EAAE,MAAM;qBACf;iBACJ;gBACD,OAAO,EAAE,IAAI;aAChB,CAAC;QACN,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;QAKI;IACM,yBAAyB,CAAC,OAAkC;QAClE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,MAAM,GAAa,EAAE,CAAC;YAE5B,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC;YACD,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC;YACD,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YACpC,CAAC;YACD,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE,CAAC;gBACnC,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;YAC1C,CAAC;YACD,IAAI,KAAK,CAAC,kBAAkB,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,CAAC,gBAAgB,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACxD,CAAC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACP,CAAC;;AA/EM,mCAAa,GAAkB,UAAU,AAA5B,CAA6B"}
+{"version":3,"file":"collectionIndexes.js","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionIndexes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,6BAA6B,GAAG;IAClC,cAAc,EAAE,CAAC,CAAC,KAAK,CACnB,CAAC,CAAC,MAAM,CAAC;QACL,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;KAC7B,CAAC,CACL;IACD,aAAa,EAAE,CAAC,CAAC,KAAK,CAClB,CAAC,CAAC,MAAM,CAAC;QACL,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;QACtB,gBAAgB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;KAC1C,CAAC,CACL;IACD,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC/B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE;CACjC,CAAC;AAOF,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IAA1D;;QAEW,gBAAW,GAAG,uCAAuC,CAAC;QACtD,cAAS,GAAG,eAAe,CAAC;QACnB,iBAAY,GAAG,6BAA6B,CAAC;IA0EjE,CAAC;IAvEa,KAAK,CAAC,OAAO,CAAC,EACpB,QAAQ,EACR,UAAU,GACqB;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAChE,MAAM,cAAc,GAAkB,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC1D,IAAI,EAAE,KAAK,CAAC,IAAc;YAC1B,GAAG,EAAE,KAAK,CAAC,GAA8B;SAC5C,CAAC,CAAC,CAAC;QAEJ,MAAM,aAAa,GAAwB,EAAE,CAAC;QAC9C,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;YAC9E,MAAM,sBAAsB,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACrF,aAAa,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAClF,CAAC;QAED,OAAO;YACH,OAAO,EAAE;gBACL,GAAG,mBAAmB,CAClB,SAAS,cAAc,CAAC,MAAM,uCAAuC,UAAU,IAAI,EACnF,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CACjC;gBACD,GAAG,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;oBACxB,CAAC,CAAC,mBAAmB,CACf,SAAS,aAAa,CAAC,MAAM,wDAAwD,UAAU,IAAI,EACnG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAChC;oBACH,CAAC,CAAC,EAAE,CAAC;aACZ;YACD,iBAAiB,EAAE;gBACf,cAAc;gBACd,aAAa;gBACb,mBAAmB,EAAE,cAAc,CAAC,MAAM;gBAC1C,kBAAkB,EAAE,aAAa,CAAC,MAAM;aAC3C;SACJ,CAAC;IACN,CAAC;IAES,KAAK,CAAC,WAAW,CAAC,KAAc,EAAE,IAAqC;QAC7E,eAAe;QACf,IAAI,KAAK,YAAY,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,KAAK,mBAAmB,EAAE,CAAC;YAC1F,OAAO;gBACH,OAAO,EAAE;oBACL;wBACI,IAAI,EAAE,oBAAoB,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,+DAA+D;wBACzH,IAAI,EAAE,MAAM;qBACf;iBACJ;gBACD,OAAO,EAAE,IAAI;aAChB,CAAC;QACN,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAqC,CAAC;IAC9E,CAAC;IAED;;;;;QAKI;IACM,yBAAyB,CAAC,OAAkC;QAClE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC3B,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,SAAS,CAAW;YAC5C,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,SAAS,CAAW;YAC5C,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAW;YAChD,SAAS,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,CAAY;YACnD,gBAAgB,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAA4B;SACjF,CAAC,CAAC,CAAC;IACR,CAAC;;AA5EM,8BAAQ,GAAG,oBAAoB,AAAvB,CAAwB;AAIhC,mCAAa,GAAkB,UAAU,AAA5B,CAA6B"}

package/dist/esm/tools/mongodb/metadata/collectionSchema.d.ts

@@ -1,9 +1,13 @@
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { MongoDBToolBase } from "../mongodbTool.js";
-import type { ToolArgs, OperationType, ToolExecutionContext } from "../../tool.js";
+import type { ToolArgs, OperationType, ToolExecutionContext, ToolResult } from "../../tool.js";
 import z from "zod";
+declare const CollectionSchemaOutputSchema: {
+    schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    fieldsCount: z.ZodNumber;
+};
+export type CollectionSchemaOutput = z.infer<z.ZodObject<typeof CollectionSchemaOutputSchema>>;
 export declare class CollectionSchemaTool extends MongoDBToolBase {
-    name: string;
+    static toolName: string;
     description: string;
     argsShape: {
         sampleSize: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
@@ -11,7 +15,12 @@ export declare class CollectionSchemaTool extends MongoDBToolBase {
         database: z.ZodString;
         collection: z.ZodString;
     };
+    outputSchema: {
+        schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        fieldsCount: z.ZodNumber;
+    };
     static operationType: OperationType;
-    protected execute({ database, collection, sampleSize, responseBytesLimit }: ToolArgs<typeof this.argsShape>, { signal }: ToolExecutionContext): Promise<CallToolResult>;
+    protected execute({ database, collection, sampleSize, responseBytesLimit }: ToolArgs<typeof this.argsShape>, { signal }: ToolExecutionContext): Promise<ToolResult<typeof this.outputSchema>>;
 }
+export {};
 //# sourceMappingURL=collectionSchema.d.ts.map

package/dist/esm/tools/mongodb/metadata/collectionSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collectionSchema.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAGnF,OAAO,CAAC,MAAM,KAAK,CAAC;AAOpB,qBAAa,oBAAqB,SAAQ,eAAe;IAC9C,IAAI,SAAuB;IAC3B,WAAW,SAA0C;IACrD,SAAS;;;;;MAUd;IAEF,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,kBAAkB,EAAE,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,EACzF,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,cAAc,CAAC;CAyC7B"}
+{"version":3,"file":"collectionSchema.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG/F,OAAO,CAAC,MAAM,KAAK,CAAC;AAOpB,QAAA,MAAM,4BAA4B;;;CAGjC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,4BAA4B,CAAC,CAAC,CAAC;AAE/F,qBAAa,oBAAqB,SAAQ,eAAe;IACrD,MAAM,CAAC,QAAQ,SAAuB;IAC/B,WAAW,SAA0C;IACrD,SAAS;;;;;MAUd;IACc,YAAY;;;MAAgC;IAE5D,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,kBAAkB,EAAE,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,EACzF,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;CA4CnD"}

package/dist/esm/tools/mongodb/metadata/collectionSchema.js

@@ -6,10 +6,13 @@ import { ONE_MB } from "../../../helpers/constants.js";
 import { collectCursorUntilMaxBytesLimit } from "../../../helpers/collectCursorUntilMaxBytes.js";
 import { isObjectEmpty } from "../../../helpers/isObjectEmpty.js";
 const MAXIMUM_SAMPLE_SIZE_HARD_LIMIT = 50000;
+const CollectionSchemaOutputSchema = {
+    schema: z.record(z.unknown()),
+    fieldsCount: z.number(),
+};
 export class CollectionSchemaTool extends MongoDBToolBase {
     constructor() {
         super(...arguments);
-        this.name = "collection-schema";
         this.description = "Describe the schema for a collection";
         this.argsShape = {
             ...DbOperationArgs,
@@ -20,14 +23,14 @@ export class CollectionSchemaTool extends MongoDBToolBase {
                 .default(ONE_MB)
                 .describe(`The maximum number of bytes to return in the response. This value is capped by the server's configured maxBytesPerQuery and cannot be exceeded.`),
         };
+        this.outputSchema = CollectionSchemaOutputSchema;
     }
     async execute({ database, collection, sampleSize, responseBytesLimit }, { signal }) {
         const provider = await this.ensureConnected();
         const cursor = provider.aggregate(database, collection, [{ $sample: { size: Math.min(sampleSize, MAXIMUM_SAMPLE_SIZE_HARD_LIMIT) } }], {
-            // @ts-expect-error signal is available in the driver but not NodeDriverServiceProvider MONGOSH-3142
             signal,
         });
-        const { cappedBy, documents } = await collectCursorUntilMaxBytesLimit({
+        const { documents } = await collectCursorUntilMaxBytesLimit({
             cursor,
             configuredMaxBytesPerQuery: this.config.maxBytesPerQuery,
             toolResponseBytesLimit: responseBytesLimit,
@@ -42,17 +45,23 @@ export class CollectionSchemaTool extends MongoDBToolBase {
                         type: "text",
                     },
                 ],
+                structuredContent: {
+                    schema: {},
+                    fieldsCount: 0,
+                },
             };
         }
         const fieldsCount = Object.keys(schema).length;
-        const header = `Found ${fieldsCount} fields in the schema for "${database}.${collection}"`;
-        const cappedWarning = cappedBy !== undefined
-            ? `\nThe schema was inferred from a subset of documents due to the response size limit. (${cappedBy})`
-            : "";
+        const header = `Found ${fieldsCount} fields in the schema for "${database}.${collection}". Note that this schema is inferred from a sample and may not represent the full schema of the collection.`;
         return {
-            content: formatUntrustedData(`${header}${cappedWarning}`, JSON.stringify(schema)),
+            content: formatUntrustedData(`${header}`, JSON.stringify(schema)),
+            structuredContent: {
+                schema,
+                fieldsCount,
+            },
         };
     }
 }
+CollectionSchemaTool.toolName = "collection-schema";
 CollectionSchemaTool.operationType = "metadata";
 //# sourceMappingURL=collectionSchema.js.map

package/dist/esm/tools/mongodb/metadata/collectionSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"collectionSchema.js","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionSchema.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,+BAA+B,EAAE,MAAM,gDAAgD,CAAC;AACjG,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAElE,MAAM,8BAA8B,GAAG,KAAM,CAAC;AAE9C,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IAAzD;;QACW,SAAI,GAAG,mBAAmB,CAAC;QAC3B,gBAAW,GAAG,sCAAsC,CAAC;QACrD,cAAS,GAAG;YACf,GAAG,eAAe;YAClB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,oDAAoD,CAAC;YAC5G,kBAAkB,EAAE,CAAC;iBAChB,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,OAAO,CAAC,MAAM,CAAC;iBACf,QAAQ,CACL,iJAAiJ,CACpJ;SACR,CAAC;IAgDN,CAAC;IA5Ca,KAAK,CAAC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,kBAAkB,EAAmC,EACzF,EAAE,MAAM,EAAwB;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAC7B,QAAQ,EACR,UAAU,EACV,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,8BAA8B,CAAC,EAAE,EAAE,CAAC,EAC7E;YACI,oGAAoG;YACpG,MAAM;SACT,CACJ,CAAC;QACF,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,MAAM,+BAA+B,CAAC;YAClE,MAAM;YACN,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;YACxD,sBAAsB,EAAE,kBAAkB;YAC1C,WAAW,EAAE,MAAM;SACtB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAEpD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YACxB,OAAO;gBACH,OAAO,EAAE;oBACL;wBACI,IAAI,EAAE,oCAAoC,QAAQ,IAAI,UAAU,sDAAsD;wBACtH,IAAI,EAAE,MAAM;qBACf;iBACJ;aACJ,CAAC;QACN,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAC/C,MAAM,MAAM,GAAG,SAAS,WAAW,8BAA8B,QAAQ,IAAI,UAAU,GAAG,CAAC;QAC3F,MAAM,aAAa,GACf,QAAQ,KAAK,SAAS;YAClB,CAAC,CAAC,yFAAyF,QAAQ,GAAG;YACtG,CAAC,CAAC,EAAE,CAAC;QAEb,OAAO;YACH,OAAO,EAAE,mBAAmB,CAAC,GAAG,MAAM,GAAG,aAAa,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SACpF,CAAC;IACN,CAAC;;AA7CM,kCAAa,GAAkB,UAAU,AAA5B,CAA6B"}
+{"version":3,"file":"collectionSchema.js","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,+BAA+B,EAAE,MAAM,gDAAgD,CAAC;AACjG,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAElE,MAAM,8BAA8B,GAAG,KAAM,CAAC;AAE9C,MAAM,4BAA4B,GAAG;IACjC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;CAC1B,CAAC;AAIF,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IAAzD;;QAEW,gBAAW,GAAG,sCAAsC,CAAC;QACrD,cAAS,GAAG;YACf,GAAG,eAAe;YAClB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,oDAAoD,CAAC;YAC5G,kBAAkB,EAAE,CAAC;iBAChB,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,OAAO,CAAC,MAAM,CAAC;iBACf,QAAQ,CACL,iJAAiJ,CACpJ;SACR,CAAC;QACc,iBAAY,GAAG,4BAA4B,CAAC;IAmDhE,CAAC;IA/Ca,KAAK,CAAC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,kBAAkB,EAAmC,EACzF,EAAE,MAAM,EAAwB;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAC7B,QAAQ,EACR,UAAU,EACV,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,8BAA8B,CAAC,EAAE,EAAE,CAAC,EAC7E;YACI,MAAM;SACT,CACJ,CAAC;QACF,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,+BAA+B,CAAC;YACxD,MAAM;YACN,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;YACxD,sBAAsB,EAAE,kBAAkB;YAC1C,WAAW,EAAE,MAAM;SACtB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAEpD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YACxB,OAAO;gBACH,OAAO,EAAE;oBACL;wBACI,IAAI,EAAE,oCAAoC,QAAQ,IAAI,UAAU,sDAAsD;wBACtH,IAAI,EAAE,MAAM;qBACf;iBACJ;gBACD,iBAAiB,EAAE;oBACf,MAAM,EAAE,EAAE;oBACV,WAAW,EAAE,CAAC;iBACjB;aACJ,CAAC;QACN,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAC/C,MAAM,MAAM,GAAG,SAAS,WAAW,8BAA8B,QAAQ,IAAI,UAAU,6GAA6G,CAAC;QAErM,OAAO;YACH,OAAO,EAAE,mBAAmB,CAAC,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACjE,iBAAiB,EAAE;gBACf,MAAM;gBACN,WAAW;aACd;SACJ,CAAC;IACN,CAAC;;AA/DM,6BAAQ,GAAG,mBAAmB,AAAtB,CAAuB;AAe/B,kCAAa,GAAkB,UAAU,AAA5B,CAA6B"}

package/dist/esm/tools/mongodb/metadata/collectionStorageSize.d.ts

@@ -1,16 +1,27 @@
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
-import type { ToolArgs, OperationType, ToolExecutionContext } from "../../tool.js";
+import type { ToolArgs, OperationType, ToolExecutionContext, ToolResult } from "../../tool.js";
+import { z } from "zod";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+declare const CollectionStorageSizeOutputSchema: {
+    size: z.ZodNumber;
+    units: z.ZodString;
+};
+export type CollectionStorageSizeOutput = z.infer<z.ZodObject<typeof CollectionStorageSizeOutputSchema>>;
 export declare class CollectionStorageSizeTool extends MongoDBToolBase {
-    name: string;
+    static toolName: string;
     description: string;
     argsShape: {
-        database: import("zod").ZodString;
-        collection: import("zod").ZodString;
+        database: z.ZodString;
+        collection: z.ZodString;
+    };
+    outputSchema: {
+        size: z.ZodNumber;
+        units: z.ZodString;
     };
     static operationType: OperationType;
-    protected execute({ database, collection }: ToolArgs<typeof DbOperationArgs>, { signal }: ToolExecutionContext): Promise<CallToolResult>;
-    protected handleError(error: unknown, args: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> | CallToolResult;
+    protected execute({ database, collection }: ToolArgs<typeof DbOperationArgs>, { signal }: ToolExecutionContext): Promise<ToolResult<typeof this.outputSchema>>;
+    protected handleError(error: unknown, args: ToolArgs<typeof this.argsShape>): Promise<CallToolResult>;
     private static getStats;
 }
+export {};
 //# sourceMappingURL=collectionStorageSize.d.ts.map

package/dist/esm/tools/mongodb/metadata/collectionStorageSize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collectionStorageSize.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionStorageSize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAEnF,qBAAa,yBAA0B,SAAQ,eAAe;IACnD,IAAI,SAA6B;IACjC,WAAW,SAAqC;IAChD,SAAS;;;MAAmB;IAEnC,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,QAAQ,CAAC,OAAO,eAAe,CAAC,EAC1D,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,cAAc,CAAC;IA6B1B,SAAS,CAAC,WAAW,CACjB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,GACtC,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc;IAgB3C,OAAO,CAAC,MAAM,CAAC,QAAQ;CAiB1B"}
+{"version":3,"file":"collectionStorageSize.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionStorageSize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC/F,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEzE,QAAA,MAAM,iCAAiC;;;CAGtC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,iCAAiC,CAAC,CAAC,CAAC;AAEzG,qBAAa,yBAA0B,SAAQ,eAAe;IAC1D,MAAM,CAAC,QAAQ,SAA6B;IACrC,WAAW,SAAqC;IAChD,SAAS;;;MAAmB;IACnB,YAAY;;;MAAqC;IAEjE,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,QAAQ,CAAC,OAAO,eAAe,CAAC,EAC1D,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;cAgChC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAgB3G,OAAO,CAAC,MAAM,CAAC,QAAQ;CAiB1B"}

package/dist/esm/tools/mongodb/metadata/collectionStorageSize.js

@@ -1,10 +1,15 @@
 import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
+import { z } from "zod";
+const CollectionStorageSizeOutputSchema = {
+    size: z.number(),
+    units: z.string(),
+};
 export class CollectionStorageSizeTool extends MongoDBToolBase {
     constructor() {
         super(...arguments);
-        this.name = "collection-storage-size";
         this.description = "Gets the size of the collection";
         this.argsShape = DbOperationArgs;
+        this.outputSchema = CollectionStorageSizeOutputSchema;
     }
     async execute({ database, collection }, { signal }) {
         const provider = await this.ensureConnected();
@@ -13,7 +18,6 @@ export class CollectionStorageSizeTool extends MongoDBToolBase {
             { $collStats: { storageStats: {} } },
             { $group: { _id: null, value: { $sum: "$storageStats.size" } } },
         ], {
-            // @ts-expect-error signal is available in the driver but not NodeDriverServiceProvider MONGOSH-3142
             signal,
         })
             .toArray());
@@ -25,9 +29,13 @@ export class CollectionStorageSizeTool extends MongoDBToolBase {
                     type: "text",
                 },
             ],
+            structuredContent: {
+                size: scaledValue,
+                units,
+            },
         };
     }
-    handleError(error, args) {
+    async handleError(error, args) {
         if (error instanceof Error && "codeName" in error && error.codeName === "NamespaceNotFound") {
             return {
                 content: [
@@ -57,5 +65,6 @@ export class CollectionStorageSizeTool extends MongoDBToolBase {
         return { value, units: "bytes" };
     }
 }
+CollectionStorageSizeTool.toolName = "collection-storage-size";
 CollectionStorageSizeTool.operationType = "metadata";
 //# sourceMappingURL=collectionStorageSize.js.map

package/dist/esm/tools/mongodb/metadata/collectionStorageSize.js.map

@@ -1 +1 @@
-{"version":3,"file":"collectionStorageSize.js","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionStorageSize.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGrE,MAAM,OAAO,yBAA0B,SAAQ,eAAe;IAA9D;;QACW,SAAI,GAAG,yBAAyB,CAAC;QACjC,gBAAW,GAAG,iCAAiC,CAAC;QAChD,cAAS,GAAG,eAAe,CAAC;IAwEvC,CAAC;IApEa,KAAK,CAAC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAoC,EAC1D,EAAE,MAAM,EAAwB;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,QAAQ;aAC9B,SAAS,CACN,QAAQ,EACR,UAAU,EACV;YACI,EAAE,UAAU,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;YACpC,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,EAAE,EAAE;SACnE,EACD;YACI,oGAAoG;YACpG,MAAM;SACT,CACJ;aACA,OAAO,EAAE,CAAwB,CAAC;QAEvC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAEhF,OAAO;YACH,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,gBAAgB,QAAQ,IAAI,UAAU,UAAU,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI;oBACzF,IAAI,EAAE,MAAM;iBACf;aACJ;SACJ,CAAC;IACN,CAAC;IAES,WAAW,CACjB,KAAc,EACd,IAAqC;QAErC,IAAI,KAAK,YAAY,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,KAAK,mBAAmB,EAAE,CAAC;YAC1F,OAAO;gBACH,OAAO,EAAE;oBACL;wBACI,IAAI,EAAE,gBAAgB,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,+DAA+D;wBACrH,IAAI,EAAE,MAAM;qBACf;iBACJ;gBACD,OAAO,EAAE,IAAI;aAChB,CAAC;QACN,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,KAAa;QACjC,MAAM,EAAE,GAAG,IAAI,CAAC;QAChB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAErB,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC;QAED,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC;QACD,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACrC,CAAC;;AArEM,uCAAa,GAAkB,UAAU,AAA5B,CAA6B"}
+{"version":3,"file":"collectionStorageSize.js","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/collectionStorageSize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,iCAAiC,GAAG;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC;AAIF,MAAM,OAAO,yBAA0B,SAAQ,eAAe;IAA9D;;QAEW,gBAAW,GAAG,iCAAiC,CAAC;QAChD,cAAS,GAAG,eAAe,CAAC;QACnB,iBAAY,GAAG,iCAAiC,CAAC;IAwErE,CAAC;IApEa,KAAK,CAAC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAoC,EAC1D,EAAE,MAAM,EAAwB;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,QAAQ;aAC9B,SAAS,CACN,QAAQ,EACR,UAAU,EACV;YACI,EAAE,UAAU,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;YACpC,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,EAAE,EAAE;SACnE,EACD;YACI,MAAM;SACT,CACJ;aACA,OAAO,EAAE,CAAwB,CAAC;QAEvC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAEhF,OAAO;YACH,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,gBAAgB,QAAQ,IAAI,UAAU,UAAU,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI;oBACzF,IAAI,EAAE,MAAM;iBACf;aACJ;YACD,iBAAiB,EAAE;gBACf,IAAI,EAAE,WAAW;gBACjB,KAAK;aACR;SACJ,CAAC;IACN,CAAC;IAES,KAAK,CAAC,WAAW,CAAC,KAAc,EAAE,IAAqC;QAC7E,IAAI,KAAK,YAAY,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,KAAK,mBAAmB,EAAE,CAAC;YAC1F,OAAO;gBACH,OAAO,EAAE;oBACL;wBACI,IAAI,EAAE,gBAAgB,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,+DAA+D;wBACrH,IAAI,EAAE,MAAM;qBACf;iBACJ;gBACD,OAAO,EAAE,IAAI;aAChB,CAAC;QACN,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAqC,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,KAAa;QACjC,MAAM,EAAE,GAAG,IAAI,CAAC;QAChB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAErB,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC;QAED,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC;QACD,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACrC,CAAC;;AA1EM,kCAAQ,GAAG,yBAAyB,AAA5B,CAA6B;AAKrC,uCAAa,GAAkB,UAAU,AAA5B,CAA6B"}

package/dist/esm/tools/mongodb/metadata/dbStats.d.ts

@@ -1,13 +1,21 @@
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { MongoDBToolBase } from "../mongodbTool.js";
-import type { ToolArgs, OperationType, ToolExecutionContext } from "../../tool.js";
+import type { ToolArgs, OperationType, ToolExecutionContext, ToolResult } from "../../tool.js";
+import { z } from "zod";
+declare const DbStatsOutputSchema: {
+    stats: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+};
+export type DbStatsOutput = z.infer<z.ZodObject<typeof DbStatsOutputSchema>>;
 export declare class DbStatsTool extends MongoDBToolBase {
-    name: string;
+    static toolName: string;
     description: string;
     argsShape: {
-        database: import("zod").ZodString;
+        database: z.ZodString;
+    };
+    outputSchema: {
+        stats: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     };
     static operationType: OperationType;
-    protected execute({ database }: ToolArgs<typeof this.argsShape>, { signal }: ToolExecutionContext): Promise<CallToolResult>;
+    protected execute({ database }: ToolArgs<typeof this.argsShape>, { signal }: ToolExecutionContext): Promise<ToolResult<typeof this.outputSchema>>;
 }
+export {};
 //# sourceMappingURL=dbStats.d.ts.map

package/dist/esm/tools/mongodb/metadata/dbStats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dbStats.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/dbStats.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAInF,qBAAa,WAAY,SAAQ,eAAe;IACrC,IAAI,SAAc;IAClB,WAAW,SAAwE;IACnF,SAAS;;MAEd;IAEF,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CACnB,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,EAC7C,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,cAAc,CAAC;CAe7B"}
+{"version":3,"file":"dbStats.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/dbStats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG/F,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,QAAA,MAAM,mBAAmB;;CAExB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC;AAE7E,qBAAa,WAAY,SAAQ,eAAe;IAC5C,MAAM,CAAC,QAAQ,SAAc;IACtB,WAAW,SAAwE;IACnF,SAAS;;MAEd;IACc,YAAY;;MAAuB;IAEnD,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CACnB,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,EAC7C,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;CAkBnD"}

package/dist/esm/tools/mongodb/metadata/dbStats.js

@@ -1,14 +1,18 @@
 import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { formatUntrustedData } from "../../tool.js";
 import { EJSON } from "bson";
+import { z } from "zod";
+const DbStatsOutputSchema = {
+    stats: z.record(z.unknown()),
+};
 export class DbStatsTool extends MongoDBToolBase {
     constructor() {
         super(...arguments);
-        this.name = "db-stats";
         this.description = "Returns statistics that reflect the use state of a single database";
         this.argsShape = {
             database: DbOperationArgs.database,
         };
+        this.outputSchema = DbStatsOutputSchema;
     }
     async execute({ database }, { signal }) {
         const provider = await this.ensureConnected();
@@ -18,8 +22,12 @@ export class DbStatsTool extends MongoDBToolBase {
         }, { signal });
         return {
             content: formatUntrustedData(`Statistics for database ${database}`, EJSON.stringify(result)),
+            structuredContent: {
+                stats: result,
+            },
         };
     }
 }
+DbStatsTool.toolName = "db-stats";
 DbStatsTool.operationType = "metadata";
 //# sourceMappingURL=dbStats.js.map

package/dist/esm/tools/mongodb/metadata/dbStats.js.map

@@ -1 +1 @@
-{"version":3,"file":"dbStats.js","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/dbStats.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAE7B,MAAM,OAAO,WAAY,SAAQ,eAAe;IAAhD;;QACW,SAAI,GAAG,UAAU,CAAC;QAClB,gBAAW,GAAG,oEAAoE,CAAC;QACnF,cAAS,GAAG;YACf,QAAQ,EAAE,eAAe,CAAC,QAAQ;SACrC,CAAC;IAsBN,CAAC;IAlBa,KAAK,CAAC,OAAO,CACnB,EAAE,QAAQ,EAAmC,EAC7C,EAAE,MAAM,EAAwB;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,mBAAmB,CAC7C,QAAQ,EACR;YACI,OAAO,EAAE,CAAC;YACV,KAAK,EAAE,CAAC;SACX,EACD,EAAE,MAAM,EAAE,CACb,CAAC;QAEF,OAAO;YACH,OAAO,EAAE,mBAAmB,CAAC,2BAA2B,QAAQ,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SAC/F,CAAC;IACN,CAAC;;AAnBM,yBAAa,GAAkB,UAAU,AAA5B,CAA6B"}
+{"version":3,"file":"dbStats.js","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/dbStats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,mBAAmB,GAAG;IACxB,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC;AAIF,MAAM,OAAO,WAAY,SAAQ,eAAe;IAAhD;;QAEW,gBAAW,GAAG,oEAAoE,CAAC;QACnF,cAAS,GAAG;YACf,QAAQ,EAAE,eAAe,CAAC,QAAQ;SACrC,CAAC;QACc,iBAAY,GAAG,mBAAmB,CAAC;IAyBvD,CAAC;IArBa,KAAK,CAAC,OAAO,CACnB,EAAE,QAAQ,EAAmC,EAC7C,EAAE,MAAM,EAAwB;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,mBAAmB,CAC7C,QAAQ,EACR;YACI,OAAO,EAAE,CAAC;YACV,KAAK,EAAE,CAAC;SACX,EACD,EAAE,MAAM,EAAE,CACb,CAAC;QAEF,OAAO;YACH,OAAO,EAAE,mBAAmB,CAAC,2BAA2B,QAAQ,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC5F,iBAAiB,EAAE;gBACf,KAAK,EAAE,MAAM;aAChB;SACJ,CAAC;IACN,CAAC;;AA7BM,oBAAQ,GAAG,UAAU,AAAb,CAAc;AAOtB,yBAAa,GAAkB,UAAU,AAA5B,CAA6B"}

package/dist/esm/tools/mongodb/metadata/explain.d.ts

@@ -1,9 +1,14 @@
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { MongoDBToolBase } from "../mongodbTool.js";
-import type { ToolArgs, OperationType, ToolExecutionContext } from "../../tool.js";
+import type { ToolArgs, OperationType, ToolExecutionContext, ToolResult } from "../../tool.js";
 import { z } from "zod";
+declare const ExplainOutputSchema: {
+    explainResult: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    method: z.ZodString;
+    verbosity: z.ZodString;
+};
+export type ExplainOutput = z.infer<z.ZodObject<typeof ExplainOutputSchema>>;
 export declare class ExplainTool extends MongoDBToolBase {
-    name: string;
+    static toolName: string;
     description: string;
     argsShape: {
         method: z.ZodArray<z.ZodDiscriminatedUnion<"name", [z.ZodObject<{
@@ -384,7 +389,13 @@ export declare class ExplainTool extends MongoDBToolBase {
         database: z.ZodString;
         collection: z.ZodString;
     };
+    outputSchema: {
+        explainResult: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        method: z.ZodString;
+        verbosity: z.ZodString;
+    };
     static operationType: OperationType;
-    protected execute({ database, collection, method: methods, verbosity }: ToolArgs<typeof this.argsShape>, { signal }: ToolExecutionContext): Promise<CallToolResult>;
+    protected execute({ database, collection, method: methods, verbosity }: ToolArgs<typeof this.argsShape>, { signal }: ToolExecutionContext): Promise<ToolResult<typeof this.outputSchema>>;
 }
+export {};
 //# sourceMappingURL=explain.d.ts.map

package/dist/esm/tools/mongodb/metadata/explain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"explain.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/explain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAEnF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,qBAAa,WAAY,SAAQ,eAAe;IACrC,IAAI,SAAa;IACjB,WAAW,SAC2G;IAEtH,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAiCd;IAEF,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,EACrF,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,cAAc,CAAC;CAiE7B"}
+{"version":3,"file":"explain.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/metadata/explain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE/F,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,QAAA,MAAM,mBAAmB;;;;CAIxB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC;AAE7E,qBAAa,WAAY,SAAQ,eAAe;IAC5C,MAAM,CAAC,QAAQ,SAAa;IACrB,WAAW,SAC2G;IAEtH,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAiCd;IACc,YAAY;;;;MAAuB;IAEnD,MAAM,CAAC,aAAa,EAAE,aAAa,CAAc;cAEjC,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,EACrF,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;CAoEnD"}

package/dist/esm/tools/mongodb/metadata/explain.js

@@ -4,10 +4,14 @@ import { z } from "zod";
 import { getAggregateArgs } from "../read/aggregate.js";
 import { FindArgs } from "../read/find.js";
 import { CountArgs } from "../read/count.js";
+const ExplainOutputSchema = {
+    explainResult: z.record(z.unknown()),
+    method: z.string(),
+    verbosity: z.string(),
+};
 export class ExplainTool extends MongoDBToolBase {
     constructor() {
         super(...arguments);
-        this.name = "explain";
         this.description = "Returns statistics describing the execution of the winning plan chosen by the query optimizer for the evaluated method";
         this.argsShape = {
             ...DbOperationArgs,
@@ -39,6 +43,7 @@ export class ExplainTool extends MongoDBToolBase {
                 .default("queryPlanner")
                 .describe("The verbosity of the explain plan, defaults to queryPlanner. If the user wants to know how fast is a query in execution time, use executionStats. It supports all verbosities as defined in the MongoDB Driver."),
         };
+        this.outputSchema = ExplainOutputSchema;
     }
     async execute({ database, collection, method: methods, verbosity }, { signal }) {
         const provider = await this.ensureConnected();
@@ -52,7 +57,6 @@ export class ExplainTool extends MongoDBToolBase {
                 const { pipeline } = method.arguments;
                 result = await provider
                     .aggregate(database, collection, pipeline, {
-                    // @ts-expect-error signal is available in the driver but not NodeDriverServiceProvider MONGOSH-3142
                     signal,
                 }, {
                     writeConcern: undefined,
@@ -65,7 +69,6 @@ export class ExplainTool extends MongoDBToolBase {
                 result = await provider
                     .find(database, collection, filter, {
                     ...rest,
-                    // @ts-expect-error signal is available in the driver but not NodeDriverServiceProvider MONGOSH-3142
                     signal,
                 })
                     .explain(verbosity);
@@ -87,8 +90,14 @@ export class ExplainTool extends MongoDBToolBase {
         }
         return {
             content: formatUntrustedData(`Here is some information about the winning plan chosen by the query optimizer for running the given \`${method.name}\` operation in "${database}.${collection}". The execution plan was run with the following verbosity: "${verbosity}". This information can be used to understand how the query was executed and to optimize the query performance.`, JSON.stringify(result)),
+            structuredContent: {
+                explainResult: result,
+                method: method.name,
+                verbosity,
+            },
         };
     }
 }
+ExplainTool.toolName = "explain";
 ExplainTool.operationType = "metadata";
 //# sourceMappingURL=explain.js.map