feat: Add MongoDB driver metadata (#2240)

PavelSafronov · marcusschiesser · web-flow · commit 91627dc936bc · 2025-12-02T15:52:18.000+08:00
Co-authored-by: Marcus Schiesser &lt;mail@marcusschiesser.de&gt;
diff --git a/.changeset/warm-pants-teach.md b/.changeset/warm-pants-teach.md
@@ -0,0 +1,8 @@
+---
+"@llamaindex/mongodb": minor
+"@llamaindex/azure": minor
+"@llamaindex/tools": minor
+"@llamaindex/examples": minor
+---
+
+Update storage providers to append MongoDB client metadata
diff --git a/examples/package.json b/examples/package.json
@@ -67,7 +67,7 @@
     "dotenv": "^17.2.0",
     "js-tiktoken": "^1.0.14",
     "llamaindex": "^0.12.0",
-    "mongodb": "6.7.0",
+    "mongodb": "6.21.0",
     "postgres": "^3.4.4",
     "wikipedia": "^2.1.2",
     "zod": "^4.1.5"
diff --git a/packages/providers/storage/azure/package.json b/packages/providers/storage/azure/package.json
@@ -72,7 +72,7 @@
     "@azure/identity": "^4.4.1",
     "@azure/search-documents": "^12.1.0",
     "@llamaindex/openai": "workspace:*",
-    "mongodb": "^6.7.0",
+    "mongodb": "^6.21.0",
     "openai": "^4.90.0"
   }
 }
diff --git a/packages/providers/storage/azure/src/chatStore/AzureCosmosMongovCoreChatStore.ts b/packages/providers/storage/azure/src/chatStore/AzureCosmosMongovCoreChatStore.ts
@@ -7,6 +7,8 @@ import type {
 import { BaseChatStore } from "@llamaindex/core/storage/chat-store";
 import type { Collection } from "mongodb";
 import { MongoClient } from "mongodb";
+import pkg from "../../package.json";
+
 const DEFAULT_CHAT_DATABASE = "ChatStoreDB";
 const DEFAULT_CHAT_Collection = "ChatStoreCollection";
 
@@ -40,6 +42,10 @@ export class AzureCosmosVCoreChatStore<
         "MongoClient is required for AzureCosmosVCoreChatStore initialization",
       );
     }
+    mongoClient.appendMetadata({
+      name: "LLAMAINDEX_AZURE_COSMOS_VCORE_CHAT_STORE",
+      version: pkg.version,
+    });
     this.mongoClient = mongoClient;
     this.dbName = dbName;
     this.collectionName = collectionName;
diff --git a/packages/providers/storage/azure/src/kvStore/AzureCosmosMongovCoreKVStore.ts b/packages/providers/storage/azure/src/kvStore/AzureCosmosMongovCoreKVStore.ts
@@ -2,6 +2,7 @@
 import { BaseKVStore } from "@llamaindex/core/storage/kv-store";
 import type { Collection } from "mongodb";
 import { MongoClient } from "mongodb";
+import pkg from "../../package.json";
 const DEFAULT_CHAT_DATABASE = "KVStoreDB";
 const DEFAULT_CHAT_Collection = "KVStoreCollection";
 
@@ -38,6 +39,10 @@ export class AzureCosmosVCoreKVStore extends BaseKVStore {
         "MongoClient is required for AzureCosmosDBNoSQLVectorStore initialization",
       );
     }
+    mongoClient.appendMetadata({
+      name: "LLAMAINDEX_AZURE_COSMOS_VCORE_KV_STORE",
+      version: pkg.version,
+    });
     this.mongoClient = mongoClient;
     this.dbName = dbName;
     this.collectionName = collectionName;
diff --git a/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts b/packages/providers/storage/azure/src/vectorStore/AzureCosmosDBMongoVectorStore.ts
@@ -10,6 +10,7 @@ import {
 } from "@llamaindex/core/vector-store";
 import { getEnv } from "@llamaindex/env";
 import { Collection, Db, MongoClient } from "mongodb";
+import pkg from "../../package.json";
 
 /** Azure Cosmos DB for MongoDB vCore Similarity type. */
 export const AzureCosmosDBMongoDBSimilarityType = {
@@ -124,6 +125,10 @@ export class AzureCosmosDBMongoDBVectorStore extends BaseVectorStore {
         appName: "LLAMAINDEX_JS",
       });
     }
+    this.mongodbClient.appendMetadata({
+      name: "LLAMAINDEX_AZURE_COSMOS_VCORE_VECTOR_STORE",
+      version: pkg.version,
+    });
 
     this.dbName = init.dbName ?? "documentsDB";
     this.collectionName = init.collectionName ?? "documents";
diff --git a/packages/providers/storage/mongodb/package.json b/packages/providers/storage/mongodb/package.json
@@ -49,6 +49,6 @@
     "@llamaindex/env": "workspace:*"
   },
   "dependencies": {
-    "mongodb": "6.7.0"
+    "mongodb": "6.21.0"
   }
 }
diff --git a/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts b/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts
@@ -16,6 +16,7 @@ import {
 import { getEnv } from "@llamaindex/env";
 import type { BulkWriteOptions, Collection } from "mongodb";
 import { MongoClient } from "mongodb";
+import pkg from "../package.json";
 
 // define your Atlas Search index. See detail https://www.mongodb.com/docs/atlas/atlas-search/field-types/knn-vector/
 const DEFAULT_EMBEDDING_DEFINITION = {
@@ -162,6 +163,10 @@ export class MongoDBAtlasVectorSearch extends BaseVectorStore {
 
     this.dbName = init.dbName ?? "default_db";
     this.collectionName = init.collectionName ?? "default_collection";
+    this.mongodbClient.appendMetadata({
+      name: "LLAMAINDEX_MONGODB_ATLAS_VECTOR_STORE",
+      version: pkg.version,
+    });
     this.autoCreateIndex = init.autoCreateIndex ?? true;
     this.indexedMetadataFields = init.indexedMetadataFields ?? [];
     this.embeddingDefinition = {
diff --git a/packages/providers/storage/mongodb/src/docStore/MongoDBDocumentStore.ts b/packages/providers/storage/mongodb/src/docStore/MongoDBDocumentStore.ts
@@ -1,5 +1,6 @@
 import { KVDocumentStore } from "@llamaindex/core/storage/doc-store";
 import { MongoClient } from "mongodb";
+import pkg from "../../package.json";
 import { MongoKVStore } from "../kvStore/MongoKVStore";
 
 const DEFAULT_DATABASE = "DocumentStoreDB";
@@ -36,6 +37,10 @@ export class MongoDocumentStore extends KVDocumentStore {
       mongoClient,
       dbName,
     });
+    mongoClient.appendMetadata({
+      name: "LLAMAINDEX_MONGODB_DOC_STORE",
+      version: pkg.version,
+    });
 
     return new MongoDocumentStore({
       mongoKVStore,
diff --git a/packages/providers/storage/mongodb/src/kvStore/MongoKVStore.ts b/packages/providers/storage/mongodb/src/kvStore/MongoKVStore.ts
@@ -24,6 +24,9 @@ export class MongoKVStore extends BaseKVStore {
 
     this.mongoClient = mongoClient;
     this.dbName = dbName;
+    this.mongoClient.appendMetadata({
+      name: "LLAMAINDEX_MONGODB_KV_STORE",
+    });
   }
 
   get client(): MongoClient {
diff --git a/packages/providers/storage/mongodb/src/tests/MongoDocumentStore.test.ts b/packages/providers/storage/mongodb/src/tests/MongoDocumentStore.test.ts
@@ -1,6 +1,16 @@
 import { Document, MetadataMode } from "@llamaindex/core/schema";
-import { MongoClient } from "mongodb";
-import { afterAll, beforeAll, beforeEach, describe, expect, it } from "vitest";
+import { MongoClient, type DriverInfo } from "mongodb";
+import {
+  afterAll,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  vi,
+  type MockInstance,
+} from "vitest";
+import pkg from "../../package.json";
 import { MongoDocumentStore } from "../docStore/MongoDBDocumentStore";
 import { setupTestDb } from "./setuptTestDb";
 
@@ -9,11 +19,13 @@ describe("MongoDocumentStore", () => {
   let mongoClient: MongoClient;
   let documentStore: MongoDocumentStore;
   let mongoUri: string;
+  let appendMetadataSpy: MockInstance<(driverInfo: DriverInfo) => void>;
 
   beforeAll(async () => {
     const testDb = await setupTestDb();
     cleanup = testDb.cleanup;
     mongoClient = testDb.mongoClient;
+    appendMetadataSpy = vi.spyOn(mongoClient, "appendMetadata");
     mongoUri = testDb.mongoUri;
     documentStore = MongoDocumentStore.fromMongoClient(mongoClient);
   }, 120000);
@@ -26,6 +38,10 @@ describe("MongoDocumentStore", () => {
     it("should create instance with mongoClient", () => {
       const store = MongoDocumentStore.fromMongoClient(mongoClient);
       expect(store).toBeInstanceOf(MongoDocumentStore);
+      expect(appendMetadataSpy).toHaveBeenCalledWith({
+        name: "LLAMAINDEX_MONGODB_DOC_STORE",
+        version: pkg.version,
+      });
     });
 
     it("should create instance with custom namespace", () => {
@@ -35,6 +51,10 @@ describe("MongoDocumentStore", () => {
         "namespace",
       );
       expect(store).toBeInstanceOf(MongoDocumentStore);
+      expect(appendMetadataSpy).toHaveBeenCalledWith({
+        name: "LLAMAINDEX_MONGODB_DOC_STORE",
+        version: pkg.version,
+      });
     });
   });
 
@@ -47,6 +67,10 @@ describe("MongoDocumentStore", () => {
     it("should create instance from MongoClient", () => {
       const store = MongoDocumentStore.fromMongoClient(mongoClient);
       expect(store).toBeInstanceOf(MongoDocumentStore);
+      expect(appendMetadataSpy).toHaveBeenCalledWith({
+        name: "LLAMAINDEX_MONGODB_DOC_STORE",
+        version: pkg.version,
+      });
     });
   });
 
diff --git a/packages/providers/storage/mongodb/src/tests/MongokVStore.test.ts b/packages/providers/storage/mongodb/src/tests/MongokVStore.test.ts
@@ -1,5 +1,14 @@
-import type { MongoClient } from "mongodb";
-import { afterAll, beforeAll, beforeEach, describe, expect, it } from "vitest";
+import type { DriverInfo, MongoClient } from "mongodb";
+import {
+  afterAll,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  vi,
+  type MockInstance,
+} from "vitest";
 import { MongoKVStore } from "../kvStore/MongoKVStore";
 import { setupTestDb } from "./setuptTestDb";
 
@@ -8,11 +17,13 @@ describe("MongoKVStore", () => {
   let mongoClient: MongoClient;
   let mongoUri: string;
   let kvStore: MongoKVStore;
+  let appendMetadataSpy: MockInstance<(driverInfo: DriverInfo) => void>;
 
   beforeAll(async () => {
     const testDb = await setupTestDb();
     cleanUp = testDb.cleanup;
     mongoClient = testDb.mongoClient;
+    appendMetadataSpy = vi.spyOn(mongoClient, "appendMetadata");
     mongoUri = testDb.mongoUri;
     kvStore = new MongoKVStore({
       mongoClient,
@@ -32,6 +43,9 @@ describe("MongoKVStore", () => {
       });
 
       expect(kvStore).toBeInstanceOf(MongoKVStore);
+      expect(appendMetadataSpy).toHaveBeenCalledWith({
+        name: "LLAMAINDEX_MONGODB_KV_STORE",
+      });
     });
 
     it("should create db with custom db and collection name", () => {
@@ -41,6 +55,9 @@ describe("MongoKVStore", () => {
       });
 
       expect(kvStore).toBeInstanceOf(MongoKVStore);
+      expect(appendMetadataSpy).toHaveBeenCalledWith({
+        name: "LLAMAINDEX_MONGODB_KV_STORE",
+      });
     });
   });
 
diff --git a/packages/providers/storage/mongodb/tsconfig.json b/packages/providers/storage/mongodb/tsconfig.json
@@ -7,7 +7,7 @@
     "outDir": "./lib",
     "tsBuildInfoFile": "./lib/.tsbuildinfo"
   },
-  "include": ["./src"],
+  "include": ["./src", "package.json"],
   "references": [
     {
       "path": "../../../core/tsconfig.json"
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@`
`72`	`72`	`"@azure/identity": "^4.4.1",`
`73`	`73`	`"@azure/search-documents": "^12.1.0",`
`74`	`74`	`"@llamaindex/openai": "workspace:*",`
`75`		`- "mongodb": "^6.7.0",`
	`75`	`+ "mongodb": "^6.21.0",`
`76`	`76`	`"openai": "^4.90.0"`
`77`	`77`	`}`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,6 @@`
`49`	`49`	`"@llamaindex/env": "workspace:*"`
`50`	`50`	`},`
`51`	`51`	`"dependencies": {`
`52`		`- "mongodb": "6.7.0"`
	`52`	`+ "mongodb": "6.21.0"`
`53`	`53`	`}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,9 @@ export class MongoKVStore extends BaseKVStore {`
`24`	`24`
`25`	`25`	`this.mongoClient = mongoClient;`
`26`	`26`	`this.dbName = dbName;`
	`27`	`+ this.mongoClient.appendMetadata({`
	`28`	`+ name: "LLAMAINDEX_MONGODB_KV_STORE",`
	`29`	`+ });`
`27`	`30`	`}`
`28`	`31`
`29`	`32`	`get client(): MongoClient {`