mongodb-mcp-server 1.2.0 → 1.3.0-pre.2

package/dist/cjs/tools/mongodb/mongodbSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongodbSchemas.js","sourceRoot":"","sources":["../../../../src/tools/mongodb/mongodbSchemas.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAoB;AACpB,wCAAoC;AAEvB,QAAA,aAAa,GAAG,aAAC;KACzB,IAAI,CAAC,CAAC,gBAAgB,EAAE,YAAY,EAAE,iBAAiB,EAAE,eAAe,CAAC,CAAC;KAC1E,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAElB,QAAA,0BAA0B,GAAG,aAAC,CAAC,MAAM,CAAC;IAC/C,wEAAwE;IACxE,2EAA2E;IAC3E,oEAAoE;IACpE,eAAe,EAAE,aAAC;SACb,KAAK,CAAC,CAAC,aAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,aAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,aAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,aAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,aAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;SACpG,OAAO,CAAC,MAAM,CAAC;SACf,SAAS,CAAC,CAAC,KAAK,EAAU,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SACpD,QAAQ,EAAE;IACf,WAAW,EAAE,aAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;CACnG,CAAC,CAAC;AAEU,QAAA,oBAAoB,GAAG,kCAA0B;KACzD,MAAM,CAAC;IACJ,qEAAqE;IACrE,gEAAgE;IAChE,6DAA6D;IAC7D,uDAAuD;IACvD,eAAe,EAAE,aAAC;SACb,KAAK,CAAC,CAAC,aAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,aAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,aAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,aAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,aAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1F,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,EAAE;IACf,SAAS,EAAE,aAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;CAC3C,CAAC;KACD,KAAK,EAAE,CAAC;AASA,QAAA,6BAA6B,GAAG,kCAA0B,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,qBAAa,EAAE,CAAC,CAAC;AAG5F,QAAA,iBAAiB,GAAG,IAAA,gBAAM,GAAE,CAAC;AAC7B,QAAA,iBAAiB,GAAG,aAAC,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,aAAC;SACX,MAAM,CAAC;QACJ,KAAK,EAAE,aAAC;aACH,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,OAAO,CAAC,KAAK,CAAC;aACd,QAAQ,CACL,uJAAuJ,CAC1J;QACL,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qEAAqE,CAAC;QACjG,IAAI,EAAE,aAAC;aACF,MAAM,EAAE;aACR,QAAQ,CACL,4NAA4N,CAC/N;QACL,WAAW,EAAE,aAAC;aACT,KAAK,CAAC,CAAC,aAAC,CAAC,MAAM,EAAE,EAAE,aAAC,CAAC,KAAK,CAAC,aAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;aACxC,QAAQ,CACL,sMAAsM,CACzM;QACL,aAAa,EAAE,aAAC;aACX,MAAM,EAAE;aACR,GAAG,EAAE;aACL,QAAQ,EAAE;aACV,QAAQ,EAAE;aACV,QAAQ,CAAC,4EAA4E,CAAC;QAC3F,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,MAAM,EAAE,IAAA,gBAAM,GAAE;aACX,QAAQ,EAAE;aACV,QAAQ,CACL,kLAAkL,CACrL;QACL,mBAAmB,EAAE,qCAA6B;aAC7C,QAAQ,EAAE;aACV,QAAQ,CACL,qMAAqM,CACxM;KACR,CAAC;SACD,WAAW,EAAE;CACrB,CAAC,CAAC"}

package/dist/cjs/tools/mongodb/mongodbTool.d.ts

@@ -1,21 +1,31 @@
 import { z } from "zod";
-import type { ToolArgs, ToolCategory, TelemetryToolMetadata } from "../tool.js";
+import type { ToolArgs, ToolCategory } from "../tool.js";
 import { ToolBase } from "../tool.js";
 import type { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import type { Server } from "../../server.js";
+import type { ConnectionMetadata } from "../../telemetry/types.js";
+import type { ToolCallback } from "@modelcontextprotocol/sdk/server/mcp.js";
 export declare const DbOperationArgs: {
     database: z.ZodString;
     collection: z.ZodString;
 };
 export declare abstract class MongoDBToolBase extends ToolBase {
     protected server?: Server;
-    category: ToolCategory;
+    static category: ToolCategory;
     protected ensureConnected(): Promise<NodeDriverServiceProvider>;
     protected ensureSearchIsSupported(): Promise<void>;
     register(server: Server): boolean;
     protected handleError(error: unknown, args: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> | CallToolResult;
-    protected connectToMongoDB(connectionString: string): Promise<void>;
-    protected resolveTelemetryMetadata(result: CallToolResult, args: ToolArgs<typeof this.argsShape>): TelemetryToolMetadata;
+    /**
+     * Resolves the tool metadata from the arguments passed to the mongoDB tools.
+     *
+     * Since MongoDB tools are executed against a MongoDB instance, the tool calls will always have the connection information.
+     *
+     * @param result - The result of the tool call.
+     * @param args - The arguments passed to the tool
+     * @returns The tool metadata
+     */
+    protected resolveTelemetryMetadata(_result: CallToolResult, _args: Parameters<ToolCallback<typeof this.argsShape>>): ConnectionMetadata;
 }
 //# sourceMappingURL=mongodbTool.d.ts.map

package/dist/cjs/tools/mongodb/mongodbTool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mongodbTool.d.ts","sourceRoot":"","sources":["../../../../src/tools/mongodb/mongodbTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACvF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAGzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,eAAe;;;CAG3B,CAAC;AAEF,8BAAsB,eAAgB,SAAQ,QAAQ;IAClD,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAa;cAE1B,eAAe,IAAI,OAAO,CAAC,yBAAyB,CAAC;IA8BrE,SAAS,CAAC,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3C,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAKxC,SAAS,CAAC,WAAW,CACjB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,GACtC,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc;IAgD3C,SAAS,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInE,SAAS,CAAC,wBAAwB,CAE9B,MAAM,EAAE,cAAc,EAEtB,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,GACtC,qBAAqB;CAU3B"}
+{"version":3,"file":"mongodbTool.d.ts","sourceRoot":"","sources":["../../../../src/tools/mongodb/mongodbTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACvF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAGzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAE5E,eAAO,MAAM,eAAe;;;CAG3B,CAAC;AAEF,8BAAsB,eAAgB,SAAQ,QAAQ;IAClD,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAa;cAE1B,eAAe,IAAI,OAAO,CAAC,yBAAyB,CAAC;IA8BrE,SAAS,CAAC,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3C,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAKxC,SAAS,CAAC,WAAW,CACjB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,GACtC,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc;IAgD3C;;;;;;;;OAQG;IACH,SAAS,CAAC,wBAAwB,CAE9B,OAAO,EAAE,cAAc,EAEvB,KAAK,EAAE,UAAU,CAAC,YAAY,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,GACvD,kBAAkB;CAGxB"}

package/dist/cjs/tools/mongodb/mongodbTool.js

@@ -10,10 +10,6 @@ exports.DbOperationArgs = {
     collection: zod_1.z.string().describe("Collection name"),
 };
 class MongoDBToolBase extends tool_js_1.ToolBase {
-    constructor() {
-        super(...arguments);
-        this.category = "mongodb";
-    }
     async ensureConnected() {
         if (!this.session.isConnectedToMongoDB) {
             if (this.session.connectedAtlasCluster) {
@@ -21,7 +17,7 @@ class MongoDBToolBase extends tool_js_1.ToolBase {
             }
             if (this.config.connectionString) {
                 try {
-                    await this.connectToMongoDB(this.config.connectionString);
+                    await this.session.connectToConfiguredConnection();
                 }
                 catch (error) {
                     this.session.logger.error({
@@ -88,21 +84,23 @@ class MongoDBToolBase extends tool_js_1.ToolBase {
         }
         return super.handleError(error, args);
     }
-    connectToMongoDB(connectionString) {
-        return this.session.connectToMongoDB({ connectionString });
-    }
+    /**
+     * Resolves the tool metadata from the arguments passed to the mongoDB tools.
+     *
+     * Since MongoDB tools are executed against a MongoDB instance, the tool calls will always have the connection information.
+     *
+     * @param result - The result of the tool call.
+     * @param args - The arguments passed to the tool
+     * @returns The tool metadata
+     */
     resolveTelemetryMetadata(
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    result, 
+    _result, 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    args) {
-        const metadata = {};
-        // Add projectId to the metadata if running a MongoDB operation to an Atlas cluster
-        if (this.session.connectedAtlasCluster?.projectId) {
-            metadata.projectId = this.session.connectedAtlasCluster.projectId;
-        }
-        return metadata;
+    _args) {
+        return this.getConnectionInfoMetadata();
     }
 }
 exports.MongoDBToolBase = MongoDBToolBase;
+MongoDBToolBase.category = "mongodb";
 //# sourceMappingURL=mongodbTool.js.map

package/dist/cjs/tools/mongodb/mongodbTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"mongodbTool.js","sourceRoot":"","sources":["../../../../src/tools/mongodb/mongodbTool.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,wCAAsC;AAGtC,sDAAkE;AAClE,sDAA+C;AAGlC,QAAA,eAAe,GAAG;IAC3B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC9C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;CACrD,CAAC;AAEF,MAAsB,eAAgB,SAAQ,kBAAQ;IAAtD;;QAEW,aAAQ,GAAiB,SAAS,CAAC;IA+G9C,CAAC;IA7Ga,KAAK,CAAC,eAAe;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACrC,IAAI,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;gBACrC,MAAM,IAAI,wBAAY,CAClB,sBAAU,CAAC,qBAAqB,EAChC,2CAA2C,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,WAAW,gCAAgC,CAC5H,CAAC;YACN,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;gBAC/B,IAAI,CAAC;oBACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;gBAC9D,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACb,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;wBACtB,EAAE,EAAE,iBAAK,CAAC,qBAAqB;wBAC/B,OAAO,EAAE,aAAa;wBACtB,OAAO,EAAE,sFAAsF,KAAe,EAAE;qBACnH,CAAC,CAAC;oBACH,MAAM,IAAI,wBAAY,CAAC,sBAAU,CAAC,6BAA6B,EAAE,2BAA2B,CAAC,CAAC;gBAClG,CAAC;YACL,CAAC;QACL,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACrC,MAAM,IAAI,wBAAY,CAAC,sBAAU,CAAC,qBAAqB,EAAE,0BAA0B,CAAC,CAAC;QACzF,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;IACxC,CAAC;IAES,uBAAuB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAChD,CAAC;IAEM,QAAQ,CAAC,MAAc;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAES,WAAW,CACjB,KAAc,EACd,IAAqC;QAErC,IAAI,KAAK,YAAY,wBAAY,EAAE,CAAC;YAChC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;gBACjB,KAAK,sBAAU,CAAC,qBAAqB,CAAC;gBACtC,KAAK,sBAAU,CAAC,6BAA6B,CAAC,CAAC,CAAC;oBAC5C,MAAM,eAAe,GAAG,KAEvB,CAAC;oBACF,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,sBAAsB,CAAC,eAAe,EAAE;wBACjE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;wBACxC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,sBAAsB;qBACzE,CAAC,CAAC;oBACH,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;wBACxB,OAAO,OAAO,CAAC,MAAM,CAAC;oBAC1B,CAAC;oBAED,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,CAAC;gBACD,KAAK,sBAAU,CAAC,iBAAiB;oBAC7B,OAAO;wBACH,OAAO,EAAE;4BACL;gCACI,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,KAAK,CAAC,OAAO;6BACtB;yBACJ;wBACD,OAAO,EAAE,IAAI;qBAChB,CAAC;gBACN,KAAK,sBAAU,CAAC,uBAAuB,CAAC,CAAC,CAAC;oBACtC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,uBAAuB,CAAC,aAAwC,CAAC;wBACtF,CAAC,CAAC,qBAAqB;wBACvB,CAAC,CAAC,WAAW,CAAC;oBAClB,OAAO;wBACH,OAAO,EAAE;4BACL;gCACI,IAAI,EAAE,iIAAiI,GAAG,iDAAiD;gCAC3L,IAAI,EAAE,MAAM;6BACf;yBACJ;wBACD,OAAO,EAAE,IAAI;qBAChB,CAAC;gBACN,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAES,gBAAgB,CAAC,gBAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC/D,CAAC;IAES,wBAAwB;IAC9B,6DAA6D;IAC7D,MAAsB;IACtB,6DAA6D;IAC7D,IAAqC;QAErC,MAAM,QAAQ,GAA0B,EAAE,CAAC;QAE3C,mFAAmF;QACnF,IAAI,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,SAAS,EAAE,CAAC;YAChD,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC;QACtE,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AAjHD,0CAiHC"}
+{"version":3,"file":"mongodbTool.js","sourceRoot":"","sources":["../../../../src/tools/mongodb/mongodbTool.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,wCAAsC;AAGtC,sDAAkE;AAClE,sDAA+C;AAKlC,QAAA,eAAe,GAAG;IAC3B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC9C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;CACrD,CAAC;AAEF,MAAsB,eAAgB,SAAQ,kBAAQ;IAIxC,KAAK,CAAC,eAAe;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACrC,IAAI,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;gBACrC,MAAM,IAAI,wBAAY,CAClB,sBAAU,CAAC,qBAAqB,EAChC,2CAA2C,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,WAAW,gCAAgC,CAC5H,CAAC;YACN,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;gBAC/B,IAAI,CAAC;oBACD,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,EAAE,CAAC;gBACvD,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACb,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;wBACtB,EAAE,EAAE,iBAAK,CAAC,qBAAqB;wBAC/B,OAAO,EAAE,aAAa;wBACtB,OAAO,EAAE,sFAAsF,KAAe,EAAE;qBACnH,CAAC,CAAC;oBACH,MAAM,IAAI,wBAAY,CAAC,sBAAU,CAAC,6BAA6B,EAAE,2BAA2B,CAAC,CAAC;gBAClG,CAAC;YACL,CAAC;QACL,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACrC,MAAM,IAAI,wBAAY,CAAC,sBAAU,CAAC,qBAAqB,EAAE,0BAA0B,CAAC,CAAC;QACzF,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;IACxC,CAAC;IAES,uBAAuB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAChD,CAAC;IAEM,QAAQ,CAAC,MAAc;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAES,WAAW,CACjB,KAAc,EACd,IAAqC;QAErC,IAAI,KAAK,YAAY,wBAAY,EAAE,CAAC;YAChC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;gBACjB,KAAK,sBAAU,CAAC,qBAAqB,CAAC;gBACtC,KAAK,sBAAU,CAAC,6BAA6B,CAAC,CAAC,CAAC;oBAC5C,MAAM,eAAe,GAAG,KAEvB,CAAC;oBACF,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,sBAAsB,CAAC,eAAe,EAAE;wBACjE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;wBACxC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,sBAAsB;qBACzE,CAAC,CAAC;oBACH,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;wBACxB,OAAO,OAAO,CAAC,MAAM,CAAC;oBAC1B,CAAC;oBAED,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,CAAC;gBACD,KAAK,sBAAU,CAAC,iBAAiB;oBAC7B,OAAO;wBACH,OAAO,EAAE;4BACL;gCACI,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,KAAK,CAAC,OAAO;6BACtB;yBACJ;wBACD,OAAO,EAAE,IAAI;qBAChB,CAAC;gBACN,KAAK,sBAAU,CAAC,uBAAuB,CAAC,CAAC,CAAC;oBACtC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,uBAAuB,CAAC,aAAwC,CAAC;wBACtF,CAAC,CAAC,qBAAqB;wBACvB,CAAC,CAAC,WAAW,CAAC;oBAClB,OAAO;wBACH,OAAO,EAAE;4BACL;gCACI,IAAI,EAAE,iIAAiI,GAAG,iDAAiD;gCAC3L,IAAI,EAAE,MAAM;6BACf;yBACJ;wBACD,OAAO,EAAE,IAAI;qBAChB,CAAC;gBACN,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACO,wBAAwB;IAC9B,6DAA6D;IAC7D,OAAuB;IACvB,6DAA6D;IAC7D,KAAsD;QAEtD,OAAO,IAAI,CAAC,yBAAyB,EAAE,CAAC;IAC5C,CAAC;;AA9GL,0CA+GC;AA7GU,wBAAQ,GAAiB,SAAS,CAAC"}

package/dist/cjs/tools/mongodb/read/aggregate.d.ts

@@ -2,8 +2,8 @@ import { z } from "zod";
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { MongoDBToolBase } from "../mongodbTool.js";
 import type { ToolArgs, OperationType, ToolExecutionContext } from "../../tool.js";
-export declare const AggregateArgs: {
-    pipeline: z.ZodArray<z.ZodUnion<[z.AnyZodObject, z.ZodObject<{
+export declare const getAggregateArgs: (vectorSearchEnabled: boolean) => {
+    readonly pipeline: z.ZodArray<z.AnyZodObject | z.ZodUnion<[z.AnyZodObject, z.ZodObject<{
         $vectorSearch: z.ZodObject<{
             exact: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
             index: z.ZodString;
@@ -13,17 +13,17 @@ export declare const AggregateArgs: {
             limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
             filter: z.ZodOptional<z.AnyZodObject>;
             embeddingParameters: z.ZodOptional<z.ZodObject<{
-                outputDimension: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<256>, z.ZodLiteral<512>, z.ZodLiteral<1024>, z.ZodLiteral<2048>, z.ZodLiteral<4096>]>>>;
-                outputDType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
+                outputDimension: z.ZodOptional<z.ZodEffects<z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"256">, z.ZodLiteral<"512">, z.ZodLiteral<"1024">, z.ZodLiteral<"2048">, z.ZodLiteral<"4096">]>>, number, "256" | "512" | "1024" | "2048" | "4096" | undefined>>;
+                outputDtype: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
             } & {
                 model: z.ZodDefault<z.ZodEnum<["voyage-3-large", "voyage-3.5", "voyage-3.5-lite", "voyage-code-3"]>>;
             }, "strip", z.ZodTypeAny, {
-                outputDimension: 256 | 512 | 1024 | 2048 | 4096;
-                outputDType: "binary" | "float" | "int8" | "uint8" | "ubinary";
+                outputDtype: "binary" | "float" | "int8" | "uint8" | "ubinary";
                 model: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3";
+                outputDimension?: number | undefined;
             }, {
-                outputDimension?: 256 | 512 | 1024 | 2048 | 4096 | undefined;
-                outputDType?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
+                outputDimension?: "256" | "512" | "1024" | "2048" | "4096" | undefined;
+                outputDtype?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
                 model?: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3" | undefined;
             }>>;
         }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
@@ -35,17 +35,17 @@ export declare const AggregateArgs: {
             limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
             filter: z.ZodOptional<z.AnyZodObject>;
             embeddingParameters: z.ZodOptional<z.ZodObject<{
-                outputDimension: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<256>, z.ZodLiteral<512>, z.ZodLiteral<1024>, z.ZodLiteral<2048>, z.ZodLiteral<4096>]>>>;
-                outputDType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
+                outputDimension: z.ZodOptional<z.ZodEffects<z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"256">, z.ZodLiteral<"512">, z.ZodLiteral<"1024">, z.ZodLiteral<"2048">, z.ZodLiteral<"4096">]>>, number, "256" | "512" | "1024" | "2048" | "4096" | undefined>>;
+                outputDtype: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
             } & {
                 model: z.ZodDefault<z.ZodEnum<["voyage-3-large", "voyage-3.5", "voyage-3.5-lite", "voyage-code-3"]>>;
             }, "strip", z.ZodTypeAny, {
-                outputDimension: 256 | 512 | 1024 | 2048 | 4096;
-                outputDType: "binary" | "float" | "int8" | "uint8" | "ubinary";
+                outputDtype: "binary" | "float" | "int8" | "uint8" | "ubinary";
                 model: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3";
+                outputDimension?: number | undefined;
             }, {
-                outputDimension?: 256 | 512 | 1024 | 2048 | 4096 | undefined;
-                outputDType?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
+                outputDimension?: "256" | "512" | "1024" | "2048" | "4096" | undefined;
+                outputDtype?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
                 model?: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3" | undefined;
             }>>;
         }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
@@ -57,17 +57,17 @@ export declare const AggregateArgs: {
             limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
             filter: z.ZodOptional<z.AnyZodObject>;
             embeddingParameters: z.ZodOptional<z.ZodObject<{
-                outputDimension: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<256>, z.ZodLiteral<512>, z.ZodLiteral<1024>, z.ZodLiteral<2048>, z.ZodLiteral<4096>]>>>;
-                outputDType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
+                outputDimension: z.ZodOptional<z.ZodEffects<z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"256">, z.ZodLiteral<"512">, z.ZodLiteral<"1024">, z.ZodLiteral<"2048">, z.ZodLiteral<"4096">]>>, number, "256" | "512" | "1024" | "2048" | "4096" | undefined>>;
+                outputDtype: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
             } & {
                 model: z.ZodDefault<z.ZodEnum<["voyage-3-large", "voyage-3.5", "voyage-3.5-lite", "voyage-code-3"]>>;
             }, "strip", z.ZodTypeAny, {
-                outputDimension: 256 | 512 | 1024 | 2048 | 4096;
-                outputDType: "binary" | "float" | "int8" | "uint8" | "ubinary";
+                outputDtype: "binary" | "float" | "int8" | "uint8" | "ubinary";
                 model: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3";
+                outputDimension?: number | undefined;
             }, {
-                outputDimension?: 256 | 512 | 1024 | 2048 | 4096 | undefined;
-                outputDType?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
+                outputDimension?: "256" | "512" | "1024" | "2048" | "4096" | undefined;
+                outputDtype?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
                 model?: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3" | undefined;
             }>>;
         }, z.ZodTypeAny, "passthrough">>;
@@ -76,17 +76,17 @@ export declare const AggregateArgs: {
             path: string;
             exact: boolean;
             index: string;
-            limit: number;
             queryVector: string | number[];
+            limit: number;
             filter?: {
                 [x: string]: any;
             } | undefined;
+            numCandidates?: number | undefined;
             embeddingParameters?: {
-                outputDimension: 256 | 512 | 1024 | 2048 | 4096;
-                outputDType: "binary" | "float" | "int8" | "uint8" | "ubinary";
+                outputDtype: "binary" | "float" | "int8" | "uint8" | "ubinary";
                 model: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3";
+                outputDimension?: number | undefined;
             } | undefined;
-            numCandidates?: number | undefined;
         } & {
             [k: string]: unknown;
         };
@@ -99,24 +99,24 @@ export declare const AggregateArgs: {
             filter?: {
                 [x: string]: any;
             } | undefined;
+            numCandidates?: number | undefined;
+            limit?: number | undefined;
             embeddingParameters?: {
-                outputDimension?: 256 | 512 | 1024 | 2048 | 4096 | undefined;
-                outputDType?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
+                outputDimension?: "256" | "512" | "1024" | "2048" | "4096" | undefined;
+                outputDtype?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
                 model?: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3" | undefined;
             } | undefined;
-            limit?: number | undefined;
-            numCandidates?: number | undefined;
         } & {
             [k: string]: unknown;
         };
     }>]>, "many">;
-    responseBytesLimit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    readonly responseBytesLimit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
 };
 export declare class AggregateTool extends MongoDBToolBase {
     name: string;
     protected description: string;
     protected argsShape: {
-        pipeline: z.ZodArray<z.ZodUnion<[z.AnyZodObject, z.ZodObject<{
+        pipeline: z.ZodArray<z.AnyZodObject | z.ZodUnion<[z.AnyZodObject, z.ZodObject<{
             $vectorSearch: z.ZodObject<{
                 exact: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
                 index: z.ZodString;
@@ -126,17 +126,17 @@ export declare class AggregateTool extends MongoDBToolBase {
                 limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
                 filter: z.ZodOptional<z.AnyZodObject>;
                 embeddingParameters: z.ZodOptional<z.ZodObject<{
-                    outputDimension: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<256>, z.ZodLiteral<512>, z.ZodLiteral<1024>, z.ZodLiteral<2048>, z.ZodLiteral<4096>]>>>;
-                    outputDType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
+                    outputDimension: z.ZodOptional<z.ZodEffects<z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"256">, z.ZodLiteral<"512">, z.ZodLiteral<"1024">, z.ZodLiteral<"2048">, z.ZodLiteral<"4096">]>>, number, "256" | "512" | "1024" | "2048" | "4096" | undefined>>;
+                    outputDtype: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
                 } & {
                     model: z.ZodDefault<z.ZodEnum<["voyage-3-large", "voyage-3.5", "voyage-3.5-lite", "voyage-code-3"]>>;
                 }, "strip", z.ZodTypeAny, {
-                    outputDimension: 256 | 512 | 1024 | 2048 | 4096;
-                    outputDType: "binary" | "float" | "int8" | "uint8" | "ubinary";
+                    outputDtype: "binary" | "float" | "int8" | "uint8" | "ubinary";
                     model: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3";
+                    outputDimension?: number | undefined;
                 }, {
-                    outputDimension?: 256 | 512 | 1024 | 2048 | 4096 | undefined;
-                    outputDType?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
+                    outputDimension?: "256" | "512" | "1024" | "2048" | "4096" | undefined;
+                    outputDtype?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
                     model?: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3" | undefined;
                 }>>;
             }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
@@ -148,17 +148,17 @@ export declare class AggregateTool extends MongoDBToolBase {
                 limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
                 filter: z.ZodOptional<z.AnyZodObject>;
                 embeddingParameters: z.ZodOptional<z.ZodObject<{
-                    outputDimension: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<256>, z.ZodLiteral<512>, z.ZodLiteral<1024>, z.ZodLiteral<2048>, z.ZodLiteral<4096>]>>>;
-                    outputDType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
+                    outputDimension: z.ZodOptional<z.ZodEffects<z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"256">, z.ZodLiteral<"512">, z.ZodLiteral<"1024">, z.ZodLiteral<"2048">, z.ZodLiteral<"4096">]>>, number, "256" | "512" | "1024" | "2048" | "4096" | undefined>>;
+                    outputDtype: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
                 } & {
                     model: z.ZodDefault<z.ZodEnum<["voyage-3-large", "voyage-3.5", "voyage-3.5-lite", "voyage-code-3"]>>;
                 }, "strip", z.ZodTypeAny, {
-                    outputDimension: 256 | 512 | 1024 | 2048 | 4096;
-                    outputDType: "binary" | "float" | "int8" | "uint8" | "ubinary";
+                    outputDtype: "binary" | "float" | "int8" | "uint8" | "ubinary";
                     model: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3";
+                    outputDimension?: number | undefined;
                 }, {
-                    outputDimension?: 256 | 512 | 1024 | 2048 | 4096 | undefined;
-                    outputDType?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
+                    outputDimension?: "256" | "512" | "1024" | "2048" | "4096" | undefined;
+                    outputDtype?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
                     model?: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3" | undefined;
                 }>>;
             }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
@@ -170,17 +170,17 @@ export declare class AggregateTool extends MongoDBToolBase {
                 limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
                 filter: z.ZodOptional<z.AnyZodObject>;
                 embeddingParameters: z.ZodOptional<z.ZodObject<{
-                    outputDimension: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<256>, z.ZodLiteral<512>, z.ZodLiteral<1024>, z.ZodLiteral<2048>, z.ZodLiteral<4096>]>>>;
-                    outputDType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
+                    outputDimension: z.ZodOptional<z.ZodEffects<z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"256">, z.ZodLiteral<"512">, z.ZodLiteral<"1024">, z.ZodLiteral<"2048">, z.ZodLiteral<"4096">]>>, number, "256" | "512" | "1024" | "2048" | "4096" | undefined>>;
+                    outputDtype: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "int8", "uint8", "binary", "ubinary"]>>>;
                 } & {
                     model: z.ZodDefault<z.ZodEnum<["voyage-3-large", "voyage-3.5", "voyage-3.5-lite", "voyage-code-3"]>>;
                 }, "strip", z.ZodTypeAny, {
-                    outputDimension: 256 | 512 | 1024 | 2048 | 4096;
-                    outputDType: "binary" | "float" | "int8" | "uint8" | "ubinary";
+                    outputDtype: "binary" | "float" | "int8" | "uint8" | "ubinary";
                     model: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3";
+                    outputDimension?: number | undefined;
                 }, {
-                    outputDimension?: 256 | 512 | 1024 | 2048 | 4096 | undefined;
-                    outputDType?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
+                    outputDimension?: "256" | "512" | "1024" | "2048" | "4096" | undefined;
+                    outputDtype?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
                     model?: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3" | undefined;
                 }>>;
             }, z.ZodTypeAny, "passthrough">>;
@@ -189,17 +189,17 @@ export declare class AggregateTool extends MongoDBToolBase {
                 path: string;
                 exact: boolean;
                 index: string;
-                limit: number;
                 queryVector: string | number[];
+                limit: number;
                 filter?: {
                     [x: string]: any;
                 } | undefined;
+                numCandidates?: number | undefined;
                 embeddingParameters?: {
-                    outputDimension: 256 | 512 | 1024 | 2048 | 4096;
-                    outputDType: "binary" | "float" | "int8" | "uint8" | "ubinary";
+                    outputDtype: "binary" | "float" | "int8" | "uint8" | "ubinary";
                     model: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3";
+                    outputDimension?: number | undefined;
                 } | undefined;
-                numCandidates?: number | undefined;
             } & {
                 [k: string]: unknown;
             };
@@ -212,13 +212,13 @@ export declare class AggregateTool extends MongoDBToolBase {
                 filter?: {
                     [x: string]: any;
                 } | undefined;
+                numCandidates?: number | undefined;
+                limit?: number | undefined;
                 embeddingParameters?: {
-                    outputDimension?: 256 | 512 | 1024 | 2048 | 4096 | undefined;
-                    outputDType?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
+                    outputDimension?: "256" | "512" | "1024" | "2048" | "4096" | undefined;
+                    outputDtype?: "binary" | "float" | "int8" | "uint8" | "ubinary" | undefined;
                     model?: "voyage-3-large" | "voyage-3.5" | "voyage-3.5-lite" | "voyage-code-3" | undefined;
                 } | undefined;
-                limit?: number | undefined;
-                numCandidates?: number | undefined;
             } & {
                 [k: string]: unknown;
             };
@@ -227,12 +227,13 @@ export declare class AggregateTool extends MongoDBToolBase {
         database: z.ZodString;
         collection: z.ZodString;
     };
-    operationType: OperationType;
+    static operationType: OperationType;
     protected execute({ database, collection, pipeline, responseBytesLimit }: ToolArgs<typeof this.argsShape>, { signal }: ToolExecutionContext): Promise<CallToolResult>;
     private safeCloseCursor;
     private assertOnlyUsesPermittedStages;
     private countAggregationResultDocuments;
     private replaceRawValuesWithEmbeddingsIfNecessary;
+    private isVectorSearchIndexUsed;
     private generateMessage;
 }
 //# sourceMappingURL=aggregate.d.ts.map

package/dist/cjs/tools/mongodb/read/aggregate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aggregate.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/read/aggregate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEzE,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAuDnF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAUzB,CAAC;AAEF,qBAAa,aAAc,SAAQ,eAAe;IACvC,IAAI,SAAe;IAC1B,SAAS,CAAC,WAAW,SAAqD;IAC1E,SAAS,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAGjB;IACK,aAAa,EAAE,aAAa,CAAU;cAE7B,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,kBAAkB,EAAE,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,EACvF,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,cAAc,CAAC;YAkEZ,eAAe;YAYf,6BAA6B;YAgC7B,+BAA+B;YA+B/B,yCAAyC;IA8CvD,OAAO,CAAC,eAAe;CAqB1B"}
+{"version":3,"file":"aggregate.d.ts","sourceRoot":"","sources":["../../../../../src/tools/mongodb/read/aggregate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEzE,OAAO,EAAmB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAiCnF,eAAO,MAAM,gBAAgB,GAAI,qBAAqB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAS9C,CAAC;AAEhB,qBAAa,aAAc,SAAQ,eAAe;IACvC,IAAI,SAAe;IAC1B,SAAS,CAAC,WAAW,SAAqD;IAC1E,SAAS,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAGjB;IACF,MAAM,CAAC,aAAa,EAAE,aAAa,CAAU;cAE7B,OAAO,CACnB,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,kBAAkB,EAAE,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,EACvF,EAAE,MAAM,EAAE,EAAE,oBAAoB,GACjC,OAAO,CAAC,cAAc,CAAC;YAyFZ,eAAe;YAYf,6BAA6B;YAgC7B,+BAA+B;YA+B/B,yCAAyC;YA6DzC,uBAAuB;IAmCrC,OAAO,CAAC,eAAe;CAqB1B"}

package/dist/cjs/tools/mongodb/read/aggregate.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AggregateTool = exports.AggregateArgs = void 0;
+exports.AggregateTool = exports.getAggregateArgs = void 0;
 const zod_1 = require("zod");
 const mongodbTool_js_1 = require("../mongodbTool.js");
 const tool_js_1 = require("../../tool.js");
@@ -10,50 +10,35 @@ const errors_js_1 = require("../../../common/errors.js");
 const collectCursorUntilMaxBytes_js_1 = require("../../../helpers/collectCursorUntilMaxBytes.js");
 const operationWithFallback_js_1 = require("../../../helpers/operationWithFallback.js");
 const constants_js_1 = require("../../../helpers/constants.js");
-const args_js_1 = require("../../args.js");
 const logger_js_1 = require("../../../common/logger.js");
-const embeddingsProvider_js_1 = require("../../../common/search/embeddingsProvider.js");
-const AnyStage = (0, args_js_1.zEJSON)();
-const VectorSearchStage = zod_1.z.object({
-    $vectorSearch: zod_1.z
-        .object({
-        exact: zod_1.z
-            .boolean()
-            .optional()
-            .default(false)
-            .describe("When true, uses an ENN algorithm, otherwise uses ANN. Using ENN is not compatible with numCandidates, in that case, numCandidates must be left empty."),
-        index: zod_1.z.string().describe("Name of the index, as retrieved from the `collection-indexes` tool."),
-        path: zod_1.z
-            .string()
-            .describe("Field, in dot notation, where to search. There must be a vector search index for that field. Note to LLM: When unsure, use the 'collection-indexes' tool to validate that the field is indexed with a vector search index."),
-        queryVector: zod_1.z
-            .union([zod_1.z.string(), zod_1.z.array(zod_1.z.number())])
-            .describe("The content to search for. The embeddingParameters field is mandatory if the queryVector is a string, in that case, the tool generates the embedding automatically using the provided configuration."),
-        numCandidates: zod_1.z
-            .number()
-            .int()
-            .positive()
-            .optional()
-            .describe("Number of candidates for the ANN algorithm. Mandatory when exact is false."),
-        limit: zod_1.z.number().int().positive().optional().default(10),
-        filter: (0, args_js_1.zEJSON)()
-            .optional()
-            .describe("MQL filter that can only use pre-filter fields from the index definition. Note to LLM: If unsure, use the `collection-indexes` tool to learn which fields can be used for pre-filtering."),
-        embeddingParameters: embeddingsProvider_js_1.zSupportedEmbeddingParameters
-            .optional()
-            .describe("The embedding model and its parameters to use to generate embeddings before searching. It is mandatory if queryVector is a string value. Note to LLM: If unsure, ask the user before providing one."),
-    })
-        .passthrough(),
-});
-exports.AggregateArgs = {
+const mongodbSchemas_js_1 = require("../mongodbSchemas.js");
+const assertVectorSearchFilterFieldsAreIndexed_js_1 = require("../../../helpers/assertVectorSearchFilterFieldsAreIndexed.js");
+const pipelineDescriptionWithVectorSearch = `\
+An array of aggregation stages to execute.
+\`$vectorSearch\` **MUST** be the first stage of the pipeline, or the first stage of a \`$unionWith\` subpipeline.
+### Usage Rules for \`$vectorSearch\`
+- **Unset embeddings:**
+  Unless the user explicitly requests the embeddings, add an \`$unset\` stage **at the end of the pipeline** to remove the embedding field and avoid context limits. **The $unset stage in this situation is mandatory**.
+- **Pre-filtering:**
+If the user requests additional filtering, include filters in \`$vectorSearch.filter\` only for pre-filter fields in the vector index.
+    NEVER include fields in $vectorSearch.filter that are not part of the vector index.
+- **Post-filtering:**
+    For all remaining filters, add a $match stage after $vectorSearch.
+### Note to LLM
+- If unsure which fields are filterable, use the collection-indexes tool to determine valid prefilter fields.
+- If no requested filters are valid prefilters, omit the filter key from $vectorSearch.\
+`;
+const genericPipelineDescription = "An array of aggregation stages to execute.";
+const getAggregateArgs = (vectorSearchEnabled) => ({
     pipeline: zod_1.z
-        .array(zod_1.z.union([AnyStage, VectorSearchStage]))
-        .describe("An array of aggregation stages to execute. $vectorSearch can only appear as the first stage of the aggregation pipeline or as the first stage of a $unionWith subpipeline. When using $vectorSearch, unless the user explicitly asks for the embeddings, $unset any embedding field to avoid reaching context limits."),
+        .array(vectorSearchEnabled ? zod_1.z.union([mongodbSchemas_js_1.AnyAggregateStage, mongodbSchemas_js_1.VectorSearchStage]) : mongodbSchemas_js_1.AnyAggregateStage)
+        .describe(vectorSearchEnabled ? pipelineDescriptionWithVectorSearch : genericPipelineDescription),
     responseBytesLimit: zod_1.z.number().optional().default(constants_js_1.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. \
+The maximum number of bytes to return in the response. This value is capped by the server's configured maxBytesPerQuery and cannot be exceeded. \
 Note to LLM: If the entire aggregation result is required, use the "export" tool instead of increasing this limit.\
 `),
-};
+});
+exports.getAggregateArgs = getAggregateArgs;
 class AggregateTool extends mongodbTool_js_1.MongoDBToolBase {
     constructor() {
         super(...arguments);
@@ -61,22 +46,41 @@ class AggregateTool extends mongodbTool_js_1.MongoDBToolBase {
         this.description = "Run an aggregation against a MongoDB collection";
         this.argsShape = {
             ...mongodbTool_js_1.DbOperationArgs,
-            ...exports.AggregateArgs,
+            ...(0, exports.getAggregateArgs)(this.isFeatureEnabled("search")),
         };
-        this.operationType = "read";
     }
     async execute({ database, collection, pipeline, responseBytesLimit }, { signal }) {
         let aggregationCursor = undefined;
         try {
             const provider = await this.ensureConnected();
             await this.assertOnlyUsesPermittedStages(pipeline);
+            if (await this.session.isSearchSupported()) {
+                (0, assertVectorSearchFilterFieldsAreIndexed_js_1.assertVectorSearchFilterFieldsAreIndexed)({
+                    searchIndexes: (await provider.getSearchIndexes(database, collection)),
+                    pipeline,
+                    logger: this.session.logger,
+                });
+            }
             // Check if aggregate operation uses an index if enabled
             if (this.config.indexCheck) {
-                await (0, indexCheck_js_1.checkIndexUsage)(provider, database, collection, "aggregate", async () => {
-                    return provider
-                        .aggregate(database, collection, pipeline, {}, { writeConcern: undefined })
-                        .explain("queryPlanner");
+                const [usesVectorSearchIndex, indexName] = await this.isVectorSearchIndexUsed({
+                    database,
+                    collection,
+                    pipeline,
                 });
+                switch (usesVectorSearchIndex) {
+                    case "not-vector-search-query":
+                        await (0, indexCheck_js_1.checkIndexUsage)(provider, database, collection, "aggregate", async () => {
+                            return provider
+                                .aggregate(database, collection, pipeline, {}, { writeConcern: undefined })
+                                .explain("queryPlanner");
+                        });
+                        break;
+                    case "non-existent-index":
+                        throw new errors_js_1.MongoDBError(errors_js_1.ErrorCodes.AtlasVectorSearchIndexNotFound, `Could not find an index with name "${indexName}" in namespace "${database}.${collection}".`);
+                    case "valid-index":
+                    // nothing to do, everything is correct so ready to run the query
+                }
             }
             pipeline = await this.replaceRawValuesWithEmbeddingsIfNecessary({
                 database,
@@ -187,22 +191,50 @@ class AggregateTool extends mongodbTool_js_1.MongoDBToolBase {
                 }
                 const embeddingParameters = vectorSearchStage.embeddingParameters;
                 delete vectorSearchStage.embeddingParameters;
-                const [embeddings] = await this.session.vectorSearchEmbeddingsManager.generateEmbeddings({
+                await this.session.vectorSearchEmbeddingsManager.assertVectorSearchIndexExists({
                     database,
                     collection,
                     path: vectorSearchStage.path,
+                });
+                const [embeddings] = await this.session.vectorSearchEmbeddingsManager.generateEmbeddings({
                     rawValues: [vectorSearchStage.queryVector],
                     embeddingParameters,
                     inputType: "query",
                 });
+                if (!embeddings) {
+                    throw new errors_js_1.MongoDBError(errors_js_1.ErrorCodes.AtlasVectorSearchInvalidQuery, "Failed to generate embeddings for the query vector.");
+                }
                 // $vectorSearch.queryVector can be a BSON.Binary: that it's not either number or an array.
                 // It's not exactly valid from the LLM perspective (they can't provide binaries).
                 // That's why we overwrite the stage in an untyped way, as what we expose and what LLMs can use is different.
                 vectorSearchStage.queryVector = embeddings;
             }
         }
+        await this.session.vectorSearchEmbeddingsManager.assertFieldsHaveCorrectEmbeddings({ database, collection }, pipeline);
         return pipeline;
     }
+    async isVectorSearchIndexUsed({ database, collection, pipeline, }) {
+        // check if the pipeline contains a $vectorSearch stage
+        let usesVectorSearch = false;
+        let indexName = "default";
+        for (const stage of pipeline) {
+            if ("$vectorSearch" in stage) {
+                const { $vectorSearch: vectorSearchStage } = stage;
+                usesVectorSearch = true;
+                indexName = vectorSearchStage.index;
+                break;
+            }
+        }
+        if (!usesVectorSearch) {
+            return ["not-vector-search-query"];
+        }
+        const indexExists = await this.session.vectorSearchEmbeddingsManager.indexExists({
+            database,
+            collection,
+            indexName,
+        });
+        return [indexExists ? "valid-index" : "non-existent-index", indexName];
+    }
     generateMessage({ aggResultsCount, documents, appliedLimits, }) {
         const appliedLimitText = appliedLimits.length
             ? `\
@@ -217,4 +249,5 @@ Returning ${documents.length} documents${appliedLimitText ? ` ${appliedLimitText
     }
 }
 exports.AggregateTool = AggregateTool;
+AggregateTool.operationType = "read";
 //# sourceMappingURL=aggregate.js.map