@mastra/mongodb 0.0.5 → 0.0.6-alpha.0

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/mongodb@0.0.5-alpha.4 build /home/runner/work/mastra/mastra/stores/mongodb
+> @mastra/mongodb@0.0.6-alpha.0 build /home/runner/work/mastra/mastra/stores/mongodb
 > tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.4.0
 TSC Build start
-TSC ⚡️ Build success in 7651ms
+TSC ⚡️ Build success in 6675ms
 DTS Build start
 CLI Target: es2022
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/stores/mongodb/dist/_tsup-dts-rollup.d.ts
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/stores/mongodb/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 9483ms
+DTS ⚡️ Build success in 8933ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 19.08 KB
-ESM ⚡️ Build success in 675ms
-CJS dist/index.cjs 19.13 KB
-CJS ⚡️ Build success in 681ms
+CJS dist/index.cjs 20.42 KB
+CJS ⚡️ Build success in 734ms
+ESM dist/index.js 20.37 KB
+ESM ⚡️ Build success in 737ms

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @mastra/mongodb
 
+## 0.0.6-alpha.0
+
+### Patch Changes
+
+- d0ee3c6: Change all public functions and constructors in vector stores to use named args and prepare to phase out positional args
+- Updated dependencies [f53a6ac]
+- Updated dependencies [eabdcd9]
+- Updated dependencies [90be034]
+- Updated dependencies [99f050a]
+- Updated dependencies [d0ee3c6]
+- Updated dependencies [23f258c]
+- Updated dependencies [2672a05]
+  - @mastra/core@0.9.5-alpha.0
+
 ## 0.0.5
 
 ### Patch Changes

package/dist/_tsup-dts-rollup.d.cts

@@ -1,5 +1,8 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 import type { CreateIndexParams } from '@mastra/core/vector';
+import type { DeleteIndexParams } from '@mastra/core/vector';
+import type { DeleteVectorParams } from '@mastra/core/vector';
+import type { DescribeIndexParams } from '@mastra/core/vector';
 import type { IndexStats } from '@mastra/core/vector';
 import { MastraVector } from '@mastra/core/vector';
 import type { MongoClientOptions } from 'mongodb';
@@ -8,6 +11,7 @@ import type { ParamsToArgs } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorArgs } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorArgs } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
@@ -33,6 +37,16 @@ export declare class MongoDBFilterTranslator extends BaseFilterTranslator {
     isEmpty(filter: any): boolean;
 }
 
+declare type MongoDBIndexReadyArgs = [string, number?, number?];
+
+declare interface MongoDBIndexReadyParams {
+    indexName: string;
+    timeoutMs?: number;
+    checkIntervalMs?: number;
+}
+export { MongoDBIndexReadyParams }
+export { MongoDBIndexReadyParams as MongoDBIndexReadyParams_alias_1 }
+
 declare type MongoDBQueryArgs = [...QueryVectorArgs, string?];
 export { MongoDBQueryArgs }
 export { MongoDBQueryArgs as MongoDBQueryArgs_alias_1 }
@@ -74,12 +88,28 @@ declare class MongoDBVector extends MastraVector {
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     createIndex(params: CreateIndexParams): Promise<void>;
-    waitForIndexReady(indexName: string, timeoutMs?: number, checkIntervalMs?: number): Promise<void>;
+    /**
+     * Waits for the index to be ready.
+     *
+     * @param params - The parameters for waiting for the index to be ready
+     * @param params.indexName - The name of the index to wait for
+     * @param params.timeoutMs - The maximum time in milliseconds to wait for the index to be ready (default: 60000)
+     * @param params.checkIntervalMs - The interval in milliseconds at which to check if the index is ready (default: 2000)
+     * @returns A promise that resolves when the index is ready
+     */
+    waitForIndexReady(...args: ParamsToArgs<MongoDBIndexReadyParams> | MongoDBIndexReadyArgs): Promise<void>;
     upsert(params: MongoDBUpsertVectorParams): Promise<string[]>;
     query(params: MongoDBQueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<IndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param params - The parameters for describing an index
+     * @param params.indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
+     */
+    describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats>;
+    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
     /**
      * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -106,10 +136,7 @@ declare class MongoDBVector extends MastraVector {
      * @returns A promise that resolves when the update is complete.
      * @throws Will throw an error if no updates are provided or if the update operation fails.
      */
-    updateVector(indexName: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -127,7 +154,7 @@ declare class MongoDBVector extends MastraVector {
      * @returns A promise that resolves when the deletion is complete.
      * @throws Will throw an error if the deletion operation fails.
      */
-    deleteVector(indexName: string, id: string): Promise<void>;
+    deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
     private getCollection;
     private validateVectorDimensions;
     private setIndexDimension;

package/dist/_tsup-dts-rollup.d.ts

@@ -1,5 +1,8 @@
 import { BaseFilterTranslator } from '@mastra/core/vector/filter';
 import type { CreateIndexParams } from '@mastra/core/vector';
+import type { DeleteIndexParams } from '@mastra/core/vector';
+import type { DeleteVectorParams } from '@mastra/core/vector';
+import type { DescribeIndexParams } from '@mastra/core/vector';
 import type { IndexStats } from '@mastra/core/vector';
 import { MastraVector } from '@mastra/core/vector';
 import type { MongoClientOptions } from 'mongodb';
@@ -8,6 +11,7 @@ import type { ParamsToArgs } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
 import type { QueryVectorArgs } from '@mastra/core/vector';
 import type { QueryVectorParams } from '@mastra/core/vector';
+import type { UpdateVectorParams } from '@mastra/core/vector';
 import type { UpsertVectorArgs } from '@mastra/core/vector';
 import type { UpsertVectorParams } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
@@ -33,6 +37,16 @@ export declare class MongoDBFilterTranslator extends BaseFilterTranslator {
     isEmpty(filter: any): boolean;
 }
 
+declare type MongoDBIndexReadyArgs = [string, number?, number?];
+
+declare interface MongoDBIndexReadyParams {
+    indexName: string;
+    timeoutMs?: number;
+    checkIntervalMs?: number;
+}
+export { MongoDBIndexReadyParams }
+export { MongoDBIndexReadyParams as MongoDBIndexReadyParams_alias_1 }
+
 declare type MongoDBQueryArgs = [...QueryVectorArgs, string?];
 export { MongoDBQueryArgs }
 export { MongoDBQueryArgs as MongoDBQueryArgs_alias_1 }
@@ -74,12 +88,28 @@ declare class MongoDBVector extends MastraVector {
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     createIndex(params: CreateIndexParams): Promise<void>;
-    waitForIndexReady(indexName: string, timeoutMs?: number, checkIntervalMs?: number): Promise<void>;
+    /**
+     * Waits for the index to be ready.
+     *
+     * @param params - The parameters for waiting for the index to be ready
+     * @param params.indexName - The name of the index to wait for
+     * @param params.timeoutMs - The maximum time in milliseconds to wait for the index to be ready (default: 60000)
+     * @param params.checkIntervalMs - The interval in milliseconds at which to check if the index is ready (default: 2000)
+     * @returns A promise that resolves when the index is ready
+     */
+    waitForIndexReady(...args: ParamsToArgs<MongoDBIndexReadyParams> | MongoDBIndexReadyArgs): Promise<void>;
     upsert(params: MongoDBUpsertVectorParams): Promise<string[]>;
     query(params: MongoDBQueryVectorParams): Promise<QueryResult[]>;
     listIndexes(): Promise<string[]>;
-    describeIndex(indexName: string): Promise<IndexStats>;
-    deleteIndex(indexName: string): Promise<void>;
+    /**
+     * Retrieves statistics about a vector index.
+     *
+     * @param params - The parameters for describing an index
+     * @param params.indexName - The name of the index to describe
+     * @returns A promise that resolves to the index statistics including dimension, count and metric
+     */
+    describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats>;
+    deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void>;
     /**
      * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -106,10 +136,7 @@ declare class MongoDBVector extends MastraVector {
      * @returns A promise that resolves when the update is complete.
      * @throws Will throw an error if no updates are provided or if the update operation fails.
      */
-    updateVector(indexName: string, id: string, update: {
-        vector?: number[];
-        metadata?: Record<string, any>;
-    }): Promise<void>;
+    updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void>;
     /**
      * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
      *
@@ -127,7 +154,7 @@ declare class MongoDBVector extends MastraVector {
      * @returns A promise that resolves when the deletion is complete.
      * @throws Will throw an error if the deletion operation fails.
      */
-    deleteVector(indexName: string, id: string): Promise<void>;
+    deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void>;
     private getCollection;
     private validateVectorDimensions;
     private setIndexDimension;

package/dist/index.cjs

@@ -160,7 +160,21 @@ var MongoDBVector = class extends vector.MastraVector {
     }
     await collection.updateOne({ _id: "__index_metadata__" }, { $set: { dimension, metric } }, { upsert: true });
   }
-  async waitForIndexReady(indexName, timeoutMs = 6e4, checkIntervalMs = 2e3) {
+  /**
+   * Waits for the index to be ready.
+   *
+   * @param params - The parameters for waiting for the index to be ready
+   * @param params.indexName - The name of the index to wait for
+   * @param params.timeoutMs - The maximum time in milliseconds to wait for the index to be ready (default: 60000)
+   * @param params.checkIntervalMs - The interval in milliseconds at which to check if the index is ready (default: 2000)
+   * @returns A promise that resolves when the index is ready
+   */
+  async waitForIndexReady(...args) {
+    const params = this.normalizeArgs("waitForIndexReady", args, [
+      "timeoutMs",
+      "checkIntervalMs"
+    ]);
+    const { indexName, timeoutMs = 6e4, checkIntervalMs = 2e3 } = params;
     const collection = await this.getCollection(indexName, true);
     const indexNameInternal = `${indexName}_vector_index`;
     const startTime = Date.now();
@@ -179,7 +193,7 @@ var MongoDBVector = class extends vector.MastraVector {
     const { indexName, vectors, metadata, ids, documents } = params;
     const collection = await this.getCollection(indexName);
     this.collectionForValidation = collection;
-    const stats = await this.describeIndex(indexName);
+    const stats = await this.describeIndex({ indexName });
     await this.validateVectorDimensions(vectors, stats.dimension);
     const generatedIds = ids || vectors.map(() => uuid.v4());
     const operations = vectors.map((vector, idx) => {
@@ -269,7 +283,16 @@ var MongoDBVector = class extends vector.MastraVector {
     const collections = await this.db.listCollections().toArray();
     return collections.map((col) => col.name);
   }
-  async describeIndex(indexName) {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param params - The parameters for describing an index
+   * @param params.indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex(...args) {
+    const params = this.normalizeArgs("describeIndex", args);
+    const { indexName } = params;
     const collection = await this.getCollection(indexName, true);
     const count = await collection.countDocuments({ _id: { $ne: "__index_metadata__" } });
     const metadataDoc = await collection.findOne({ _id: "__index_metadata__" });
@@ -281,7 +304,9 @@ var MongoDBVector = class extends vector.MastraVector {
       metric
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     const collection = await this.getCollection(indexName, false);
     if (collection) {
       await collection.drop();
@@ -308,7 +333,7 @@ var MongoDBVector = class extends vector.MastraVector {
       Please use updateVector() instead. 
       updateIndexById() will be removed on May 20th, 2025.`
     );
-    await this.updateVector(indexName, id, update);
+    await this.updateVector({ indexName, id, update });
   }
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
@@ -320,7 +345,9 @@ var MongoDBVector = class extends vector.MastraVector {
    * @returns A promise that resolves when the update is complete.
    * @throws Will throw an error if no updates are provided or if the update operation fails.
    */
-  async updateVector(indexName, id, update) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { indexName, id, update } = params;
     try {
       if (!update.vector && !update.metadata) {
         throw new Error("No updates provided");
@@ -328,7 +355,7 @@ var MongoDBVector = class extends vector.MastraVector {
       const collection = await this.getCollection(indexName, true);
       const updateDoc = {};
       if (update.vector) {
-        const stats = await this.describeIndex(indexName);
+        const stats = await this.describeIndex({ indexName });
         await this.validateVectorDimensions([update.vector], stats.dimension);
         updateDoc[this.embeddingFieldName] = update.vector;
       }
@@ -362,7 +389,7 @@ var MongoDBVector = class extends vector.MastraVector {
       Please use deleteVector() instead. 
       deleteIndexById() will be removed on May 20th, 2025.`
     );
-    await this.deleteVector(indexName, id);
+    await this.deleteVector({ indexName, id });
   }
   /**
    * Deletes a vector by its ID.
@@ -371,7 +398,9 @@ var MongoDBVector = class extends vector.MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(indexName, id) {
+  async deleteVector(...args) {
+    const params = this.normalizeArgs("deleteVector", args);
+    const { indexName, id } = params;
     try {
       const collection = await this.getCollection(indexName, true);
       await collection.deleteOne({ _id: id });

package/dist/index.d.cts

@@ -4,4 +4,5 @@ export { MongoDBQueryArgs } from './_tsup-dts-rollup.cjs';
 export { MongoDBUpsertParams } from './_tsup-dts-rollup.cjs';
 export { MongoDBUpsertVectorParams } from './_tsup-dts-rollup.cjs';
 export { MongoDBQueryVectorParams } from './_tsup-dts-rollup.cjs';
+export { MongoDBIndexReadyParams } from './_tsup-dts-rollup.cjs';
 export { MongoDBVector } from './_tsup-dts-rollup.cjs';

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export { MongoDBQueryArgs } from './_tsup-dts-rollup.js';
 export { MongoDBUpsertParams } from './_tsup-dts-rollup.js';
 export { MongoDBUpsertVectorParams } from './_tsup-dts-rollup.js';
 export { MongoDBQueryVectorParams } from './_tsup-dts-rollup.js';
+export { MongoDBIndexReadyParams } from './_tsup-dts-rollup.js';
 export { MongoDBVector } from './_tsup-dts-rollup.js';

package/dist/index.js

@@ -158,7 +158,21 @@ var MongoDBVector = class extends MastraVector {
     }
     await collection.updateOne({ _id: "__index_metadata__" }, { $set: { dimension, metric } }, { upsert: true });
   }
-  async waitForIndexReady(indexName, timeoutMs = 6e4, checkIntervalMs = 2e3) {
+  /**
+   * Waits for the index to be ready.
+   *
+   * @param params - The parameters for waiting for the index to be ready
+   * @param params.indexName - The name of the index to wait for
+   * @param params.timeoutMs - The maximum time in milliseconds to wait for the index to be ready (default: 60000)
+   * @param params.checkIntervalMs - The interval in milliseconds at which to check if the index is ready (default: 2000)
+   * @returns A promise that resolves when the index is ready
+   */
+  async waitForIndexReady(...args) {
+    const params = this.normalizeArgs("waitForIndexReady", args, [
+      "timeoutMs",
+      "checkIntervalMs"
+    ]);
+    const { indexName, timeoutMs = 6e4, checkIntervalMs = 2e3 } = params;
     const collection = await this.getCollection(indexName, true);
     const indexNameInternal = `${indexName}_vector_index`;
     const startTime = Date.now();
@@ -177,7 +191,7 @@ var MongoDBVector = class extends MastraVector {
     const { indexName, vectors, metadata, ids, documents } = params;
     const collection = await this.getCollection(indexName);
     this.collectionForValidation = collection;
-    const stats = await this.describeIndex(indexName);
+    const stats = await this.describeIndex({ indexName });
     await this.validateVectorDimensions(vectors, stats.dimension);
     const generatedIds = ids || vectors.map(() => v4());
     const operations = vectors.map((vector, idx) => {
@@ -267,7 +281,16 @@ var MongoDBVector = class extends MastraVector {
     const collections = await this.db.listCollections().toArray();
     return collections.map((col) => col.name);
   }
-  async describeIndex(indexName) {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param params - The parameters for describing an index
+   * @param params.indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex(...args) {
+    const params = this.normalizeArgs("describeIndex", args);
+    const { indexName } = params;
     const collection = await this.getCollection(indexName, true);
     const count = await collection.countDocuments({ _id: { $ne: "__index_metadata__" } });
     const metadataDoc = await collection.findOne({ _id: "__index_metadata__" });
@@ -279,7 +302,9 @@ var MongoDBVector = class extends MastraVector {
       metric
     };
   }
-  async deleteIndex(indexName) {
+  async deleteIndex(...args) {
+    const params = this.normalizeArgs("deleteIndex", args);
+    const { indexName } = params;
     const collection = await this.getCollection(indexName, false);
     if (collection) {
       await collection.drop();
@@ -306,7 +331,7 @@ var MongoDBVector = class extends MastraVector {
       Please use updateVector() instead. 
       updateIndexById() will be removed on May 20th, 2025.`
     );
-    await this.updateVector(indexName, id, update);
+    await this.updateVector({ indexName, id, update });
   }
   /**
    * Updates a vector by its ID with the provided vector and/or metadata.
@@ -318,7 +343,9 @@ var MongoDBVector = class extends MastraVector {
    * @returns A promise that resolves when the update is complete.
    * @throws Will throw an error if no updates are provided or if the update operation fails.
    */
-  async updateVector(indexName, id, update) {
+  async updateVector(...args) {
+    const params = this.normalizeArgs("updateVector", args);
+    const { indexName, id, update } = params;
     try {
       if (!update.vector && !update.metadata) {
         throw new Error("No updates provided");
@@ -326,7 +353,7 @@ var MongoDBVector = class extends MastraVector {
       const collection = await this.getCollection(indexName, true);
       const updateDoc = {};
       if (update.vector) {
-        const stats = await this.describeIndex(indexName);
+        const stats = await this.describeIndex({ indexName });
         await this.validateVectorDimensions([update.vector], stats.dimension);
         updateDoc[this.embeddingFieldName] = update.vector;
       }
@@ -360,7 +387,7 @@ var MongoDBVector = class extends MastraVector {
       Please use deleteVector() instead. 
       deleteIndexById() will be removed on May 20th, 2025.`
     );
-    await this.deleteVector(indexName, id);
+    await this.deleteVector({ indexName, id });
   }
   /**
    * Deletes a vector by its ID.
@@ -369,7 +396,9 @@ var MongoDBVector = class extends MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(indexName, id) {
+  async deleteVector(...args) {
+    const params = this.normalizeArgs("deleteVector", args);
+    const { indexName, id } = params;
     try {
       const collection = await this.getCollection(indexName, true);
       await collection.deleteOne({ _id: id });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mongodb",
-  "version": "0.0.5",
+  "version": "0.0.6-alpha.0",
   "description": "MongoDB provider for Mastra - includes vector store capabilities",
   "type": "module",
   "main": "dist/index.js",
@@ -23,7 +23,7 @@
     "cloudflare": "^4.1.0",
     "mongodb": "^6.15.0",
     "uuid": "^11.1.0",
-    "@mastra/core": "^0.9.4"
+    "@mastra/core": "^0.9.5-alpha.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.5",

package/src/vector/index.test.ts

@@ -60,7 +60,7 @@ async function createIndexAndWait(
   metric: 'cosine' | 'euclidean' | 'dotproduct',
 ) {
   await vectorDB.createIndex({ indexName, dimension, metric });
-  await vectorDB.waitForIndexReady(indexName);
+  await vectorDB.waitForIndexReady({ indexName });
   const created = await waitForCondition(
     async () => {
       const cols = await vectorDB.listIndexes();
@@ -75,7 +75,7 @@ async function createIndexAndWait(
 // Delete index (collection) and wait until it is removed
 async function deleteIndexAndWait(vectorDB: MongoDBVector, indexName: string) {
   try {
-    await vectorDB.deleteIndex(indexName);
+    await vectorDB.deleteIndex({ indexName });
     const deleted = await waitForCondition(
       async () => {
         const cols = await vectorDB.listIndexes();
@@ -105,7 +105,7 @@ describe('MongoDBVector Integration Tests', () => {
     // Cleanup any existing collections
     try {
       const cols = await vectorDB.listIndexes();
-      await Promise.all(cols.map(c => vectorDB.deleteIndex(c)));
+      await Promise.all(cols.map(c => vectorDB.deleteIndex({ indexName: c })));
       const deleted = await waitForCondition(async () => (await vectorDB.listIndexes()).length === 0, 30000, 2000);
       if (!deleted) throw new Error('Timed out waiting for collections to be deleted');
     } catch (error) {
@@ -119,12 +119,12 @@ describe('MongoDBVector Integration Tests', () => {
 
   afterAll(async () => {
     try {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
     } catch (error) {
       console.error('Failed to delete test collection:', error);
     }
     try {
-      await vectorDB.deleteIndex(testIndexName2);
+      await vectorDB.deleteIndex({ indexName: testIndexName2 });
     } catch (error) {
       console.error('Failed to delete test collection:', error);
     }
@@ -137,7 +137,7 @@ describe('MongoDBVector Integration Tests', () => {
     expect(cols).toContain(testIndexName);
 
     // Check stats (should be zero docs initially)
-    const initialStats = await vectorDB.describeIndex(testIndexName);
+    const initialStats = await vectorDB.describeIndex({ indexName: testIndexName });
     expect(initialStats).toEqual({ dimension: 4, metric: 'cosine', count: 0 });
 
     // Upsert 4 vectors with metadata
@@ -153,7 +153,7 @@ describe('MongoDBVector Integration Tests', () => {
 
     // Wait for the document count to update (increased delay to 5000ms)
     await new Promise(resolve => setTimeout(resolve, 5000));
-    const updatedStats = await vectorDB.describeIndex(testIndexName);
+    const updatedStats = await vectorDB.describeIndex({ indexName: testIndexName });
     expect(updatedStats.count).toEqual(4);
 
     // Query for similar vectors (delay again to allow for index update)
@@ -175,7 +175,7 @@ describe('MongoDBVector Integration Tests', () => {
     expect(filteredResults[0]?.metadata).toEqual({ label: 'vector2' });
 
     // Final stats should show > 0 documents
-    const finalStats = await vectorDB.describeIndex(testIndexName);
+    const finalStats = await vectorDB.describeIndex({ indexName: testIndexName });
     expect(finalStats.count).toBeGreaterThan(0);
   });
 
@@ -379,7 +379,11 @@ describe('MongoDBVector Integration Tests', () => {
       const idToBeUpdated = ids[0];
       const newVector = [1, 2, 3, 4];
       const newMetaData = { test: 'updates' };
-      await vectorDB.updateVector(indexName, idToBeUpdated, { vector: newVector, metadata: newMetaData });
+      await vectorDB.updateVector({
+        indexName,
+        id: idToBeUpdated,
+        update: { vector: newVector, metadata: newMetaData },
+      });
       await new Promise(resolve => setTimeout(resolve, 5000));
       const results = await vectorDB.query({
         indexName,
@@ -399,7 +403,7 @@ describe('MongoDBVector Integration Tests', () => {
       expect(ids).toHaveLength(4);
       const idToBeUpdated = ids[0];
       const newMetaData = { test: 'metadata only update' };
-      await vectorDB.updateVector(indexName, idToBeUpdated, { metadata: newMetaData });
+      await vectorDB.updateVector({ indexName, id: idToBeUpdated, update: { metadata: newMetaData } });
       await new Promise(resolve => setTimeout(resolve, 5000));
       const results = await vectorDB.query({
         indexName,
@@ -419,7 +423,7 @@ describe('MongoDBVector Integration Tests', () => {
       expect(ids).toHaveLength(4);
       const idToBeUpdated = ids[0];
       const newVector = [1, 2, 3, 4];
-      await vectorDB.updateVector(indexName, idToBeUpdated, { vector: newVector });
+      await vectorDB.updateVector({ indexName, id: idToBeUpdated, update: { vector: newVector } });
       await new Promise(resolve => setTimeout(resolve, 5000));
       const results = await vectorDB.query({
         indexName,
@@ -434,21 +438,23 @@ describe('MongoDBVector Integration Tests', () => {
       expect(updatedResult?.vector).toEqual(newVector);
     });
     it('should throw exception when no updates are given', async () => {
-      await expect(vectorDB.updateVector(indexName, 'nonexistent-id', {})).rejects.toThrow('No updates provided');
+      await expect(vectorDB.updateVector({ indexName, id: 'nonexistent-id', update: {} })).rejects.toThrow(
+        'No updates provided',
+      );
     });
     it('should delete the vector by id', async () => {
       const ids = await vectorDB.upsert({ indexName, vectors: testVectors });
       expect(ids).toHaveLength(4);
       const idToBeDeleted = ids[0];
 
-      const initialStats = await vectorDB.describeIndex(indexName);
+      const initialStats = await vectorDB.describeIndex({ indexName });
 
-      await vectorDB.deleteVector(indexName, idToBeDeleted);
+      await vectorDB.deleteVector({ indexName, id: idToBeDeleted });
       const results = await vectorDB.query({ indexName, queryVector: [1, 0, 0, 0], topK: 2 });
       expect(results.map(res => res.id)).not.toContain(idToBeDeleted);
 
       await new Promise(resolve => setTimeout(resolve, 5000)); // Wait for count to update
-      const finalStats = await vectorDB.describeIndex(indexName);
+      const finalStats = await vectorDB.describeIndex({ indexName });
       expect(finalStats.count).toBe(initialStats.count - 1);
     });
   });

package/src/vector/index.ts

@@ -8,6 +8,10 @@ import type {
   ParamsToArgs,
   QueryVectorArgs,
   UpsertVectorArgs,
+  DescribeIndexParams,
+  DeleteIndexParams,
+  DeleteVectorParams,
+  UpdateVectorParams,
 } from '@mastra/core/vector';
 import type { VectorFilter } from '@mastra/core/vector/filter';
 import { MongoClient } from 'mongodb';
@@ -29,6 +33,14 @@ export interface MongoDBQueryVectorParams extends QueryVectorParams {
   documentFilter?: VectorFilter;
 }
 
+export interface MongoDBIndexReadyParams {
+  indexName: string;
+  timeoutMs?: number;
+  checkIntervalMs?: number;
+}
+
+type MongoDBIndexReadyArgs = [string, number?, number?];
+
 // Define the document interface
 interface MongoDBDocument extends Document {
   _id: string; // Explicitly declare '_id' as string
@@ -118,7 +130,21 @@ export class MongoDBVector extends MastraVector {
     await collection.updateOne({ _id: '__index_metadata__' }, { $set: { dimension, metric } }, { upsert: true });
   }
 
-  async waitForIndexReady(indexName: string, timeoutMs: number = 60000, checkIntervalMs: number = 2000): Promise<void> {
+  /**
+   * Waits for the index to be ready.
+   *
+   * @param params - The parameters for waiting for the index to be ready
+   * @param params.indexName - The name of the index to wait for
+   * @param params.timeoutMs - The maximum time in milliseconds to wait for the index to be ready (default: 60000)
+   * @param params.checkIntervalMs - The interval in milliseconds at which to check if the index is ready (default: 2000)
+   * @returns A promise that resolves when the index is ready
+   */
+  async waitForIndexReady(...args: ParamsToArgs<MongoDBIndexReadyParams> | MongoDBIndexReadyArgs): Promise<void> {
+    const params = this.normalizeArgs<MongoDBIndexReadyParams, MongoDBIndexReadyArgs>('waitForIndexReady', args, [
+      'timeoutMs',
+      'checkIntervalMs',
+    ]);
+    const { indexName, timeoutMs = 60000, checkIntervalMs = 2000 } = params;
     const collection = await this.getCollection(indexName, true);
     const indexNameInternal = `${indexName}_vector_index`;
 
@@ -143,7 +169,7 @@ export class MongoDBVector extends MastraVector {
     this.collectionForValidation = collection;
 
     // Get index stats to check dimension
-    const stats = await this.describeIndex(indexName);
+    const stats = await this.describeIndex({ indexName });
 
     // Validate vector dimensions
     await this.validateVectorDimensions(vectors, stats.dimension);
@@ -255,7 +281,17 @@ export class MongoDBVector extends MastraVector {
     return collections.map(col => col.name);
   }
 
-  async describeIndex(indexName: string): Promise<IndexStats> {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param params - The parameters for describing an index
+   * @param params.indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats> {
+    const params = this.normalizeArgs<DescribeIndexParams>('describeIndex', args);
+
+    const { indexName } = params;
     const collection = await this.getCollection(indexName, true);
 
     // Get the count of documents, excluding the metadata document
@@ -273,7 +309,10 @@ export class MongoDBVector extends MastraVector {
     };
   }
 
-  async deleteIndex(indexName: string): Promise<void> {
+  async deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void> {
+    const params = this.normalizeArgs<DeleteIndexParams>('deleteIndex', args);
+
+    const { indexName } = params;
     const collection = await this.getCollection(indexName, false); // Do not throw error if collection doesn't exist
     if (collection) {
       await collection.drop();
@@ -306,7 +345,7 @@ export class MongoDBVector extends MastraVector {
       Please use updateVector() instead. 
       updateIndexById() will be removed on May 20th, 2025.`,
     );
-    await this.updateVector(indexName, id, update);
+    await this.updateVector({ indexName, id, update });
   }
 
   /**
@@ -319,11 +358,9 @@ export class MongoDBVector extends MastraVector {
    * @returns A promise that resolves when the update is complete.
    * @throws Will throw an error if no updates are provided or if the update operation fails.
    */
-  async updateVector(
-    indexName: string,
-    id: string,
-    update: { vector?: number[]; metadata?: Record<string, any> },
-  ): Promise<void> {
+  async updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void> {
+    const params = this.normalizeArgs<UpdateVectorParams>('updateVector', args);
+    const { indexName, id, update } = params;
     try {
       if (!update.vector && !update.metadata) {
         throw new Error('No updates provided');
@@ -333,7 +370,7 @@ export class MongoDBVector extends MastraVector {
       const updateDoc: Record<string, any> = {};
 
       if (update.vector) {
-        const stats = await this.describeIndex(indexName);
+        const stats = await this.describeIndex({ indexName });
         await this.validateVectorDimensions([update.vector], stats.dimension);
         updateDoc[this.embeddingFieldName] = update.vector;
       }
@@ -373,7 +410,7 @@ export class MongoDBVector extends MastraVector {
       Please use deleteVector() instead. 
       deleteIndexById() will be removed on May 20th, 2025.`,
     );
-    await this.deleteVector(indexName, id);
+    await this.deleteVector({ indexName, id });
   }
 
   /**
@@ -383,7 +420,9 @@ export class MongoDBVector extends MastraVector {
    * @returns A promise that resolves when the deletion is complete.
    * @throws Will throw an error if the deletion operation fails.
    */
-  async deleteVector(indexName: string, id: string): Promise<void> {
+  async deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void> {
+    const params = this.normalizeArgs<DeleteVectorParams>('deleteVector', args);
+    const { indexName, id } = params;
     try {
       const collection = await this.getCollection(indexName, true);
       await collection.deleteOne({ _id: id });