Support for listing search indexes

Author: manoj-pillay-10gen

src/tools/mongodb/read/collectionSearchIndexes.ts

@@ -0,0 +1,46 @@
+import {DbOperationArgs, MongoDBToolBase} from "../mongodbTool.js";
+import {CallToolResult} from "@modelcontextprotocol/sdk/types.js";
+import { ToolArgs, OperationType } from "../../tool.js";
+import {z} from "zod";
+
+export const ListSearchIndexesArgs = {
+  indexName: z
+  .string()
+  .default('')
+  .optional()
+  .describe("The name of the index to return information about. Returns all indexes on collection if not provided."),
+}
+
+export class CollectionSearchIndexesTool extends MongoDBToolBase {
+  protected name = "collection-search-indexes";
+  protected description = "List one or all search indexes on a collection";
+  protected argsShape = {
+    ...DbOperationArgs,
+    ...ListSearchIndexesArgs,
+  };
+
+  protected operationType: OperationType = "read";
+
+  protected async execute({ database, collection, indexName }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
+    const provider = await this.ensureConnected();
+    const indexes = await provider
+    .getSearchIndexes(database, collection, indexName);
+
+    return {
+      content: [
+        {
+          text: indexName
+              ? `Found ${indexes.length} search indexes  in the collection "${collection}" with name "${indexName}":`
+              : `Found ${indexes.length} search indexes  in the collection "${collection}"`,
+          type: "text",
+        },
+        ...(indexes.map((indexDefinition) => {
+          return {
+            text: `Name "${indexDefinition.name}", definition: ${JSON.stringify(indexDefinition.latestDefinition)}`,
+            type: "text",
+          };
+        }) as { text: string; type: "text" }[]),
+      ],
+    };
+  }
+}

src/tools/mongodb/tools.ts

@@ -18,12 +18,14 @@ import { DropCollectionTool } from "./delete/dropCollection.js";
 import { ExplainTool } from "./metadata/explain.js";
 import { CreateCollectionTool } from "./create/createCollection.js";
 import { LogsTool } from "./metadata/logs.js";
+import {CollectionSearchIndexesTool} from "./read/collectionSearchIndexes.js";
 
 export const MongoDbTools = [
     ConnectTool,
     ListCollectionsTool,
     ListDatabasesTool,
     CollectionIndexesTool,
+    CollectionSearchIndexesTool,
     CreateIndexTool,
     CollectionSchemaTool,
     FindTool,

tests/integration/tools/mongodb/read/collectionSearchIndexes.test.ts

@@ -0,0 +1,20 @@
+import { describeWithMongoDB } from "../mongodbHelpers.js";
+
+import {
+  databaseCollectionParameters,
+  databaseCollectionInvalidArgs,
+  validateThrowsForInvalidArguments,
+  validateToolMetadata,
+} from "../../../helpers.js";
+
+describeWithMongoDB("collectionSearchIndexes tool", (integration) => {
+    validateToolMetadata(
+        integration,
+        "collection-search-indexes",
+        "Describe the search indexes for a collection",
+        databaseCollectionParameters
+    );
+    validateThrowsForInvalidArguments(integration, "collection-search-indexes", databaseCollectionInvalidArgs);
+
+    // Real tests to be added once search indexes are supported in test env.
+});