Skip to content

feat: listSearchIndexes now lists index status info #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 16, 2025
Merged

feat: listSearchIndexes now lists index status info #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,19 +142,26 @@ NOTE: atlas tools are only available when you set credentials on [configuration]
- `insert-one` - Insert a single document into a MongoDB collection
- `insert-many` - Insert multiple documents into a MongoDB collection
- `create-index` - Create an index for a MongoDB collection
- `create-search-index` - Create a search index for a MongoDB collection
- `create-vector-index` - Create a vector search index for a MongoDB collection
- `update-one` - Update a single document in a MongoDB collection
- `update-many` - Update multiple documents in a MongoDB collection
- `update-search-index` - Update a search index for a MongoDB collection
- `update-vector-index` - Update a vector search index for a MongoDB collection
- `rename-collection` - Rename a MongoDB collection
- `delete-one` - Delete a single document from a MongoDB collection
- `delete-many` - Delete multiple documents from a MongoDB collection
- `drop-collection` - Remove a collection from a MongoDB database
- `drop-database` - Remove a MongoDB database
- `drop-search-index` - Remove a search or vector search index from a MongoDB collection
- `list-databases` - List all databases for a MongoDB connection
- `list-collections` - List all collections for a given database
- `collection-indexes` - Describe the indexes for a collection
- `collection-search-indexes` - Describe the search indexes for a collection
- `collection-schema` - Describe the schema for a collection
- `collection-storage-size` - Get the size of a collection in MB
- `db-stats` - Return statistics about a MongoDB database
- `run-pipeline` - Run an aggregation against JSON documents (Atlas account not required)

## Configuration

Expand Down
49 changes: 49 additions & 0 deletions src/common/search/listSearchIndexesOutput.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
export interface IndexDefinitionVersion {
version: number;
createdAt: string; // ISO 8601 date string
}

export interface IndexDefinition {
[key: string]: unknown;
}

export interface SynonymMappingStatusDetails {
status: string;
queryable: boolean;
message?: string;
}

export interface IndexStatusInfo {
status: string;
queryable: boolean;
synonymMappingStatus?: string;
synonymMappingStatusDetails?: SynonymMappingStatusDetails;
definitionVersion: IndexDefinitionVersion;
definition: IndexDefinition;
}

export interface SearchIndexStatusDetail {
hostname: string;
status: string;
queryable: boolean;
mainIndex: IndexStatusInfo;
stagedIndex?: IndexStatusInfo;
}

export interface SynonymMappingStatusDetail {
status: string;
queryable: boolean;
message?: string;
}

export interface ListSearchIndexOutput {
id: string;
name: string;
status: string;
queryable: boolean;
latestDefinitionVersion: IndexDefinitionVersion;
latestDefinition: IndexDefinition;
statusDetail: SearchIndexStatusDetail[];
synonymMappingStatus?: "BUILDING" | "FAILED" | "READY";
synonymMappingStatusDetail?: SynonymMappingStatusDetail[];
}
29 changes: 21 additions & 8 deletions src/tools/mongodb/read/collectionSearchIndexes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { ToolArgs, OperationType } from "../../tool.js";
import { z } from "zod";
import { ListSearchIndexOutput } from "../../../common/search/listSearchIndexesOutput.js";

export const ListSearchIndexesArgs = {
indexName: z
Expand All @@ -12,10 +13,6 @@ export const ListSearchIndexesArgs = {
"The name of the index to return information about. Returns all indexes on collection if not provided."
),
};
export interface SearchIndex {
name: string;
latestDefinition: Record<string, unknown>;
}

export class CollectionSearchIndexesTool extends MongoDBToolBase {
protected name = "collection-search-indexes";
Expand All @@ -33,12 +30,18 @@ export class CollectionSearchIndexesTool extends MongoDBToolBase {
indexName,
}: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
const provider = await this.ensureConnected();

const indexes: SearchIndex[] = (
(await provider.getSearchIndexes(database, collection, indexName)) as SearchIndex[]
const indexes: ListSearchIndexOutput[] = (
(await provider.getSearchIndexes(database, collection, indexName)) as ListSearchIndexOutput[]
).map((doc) => ({
id: doc.id,
name: doc.name,
status: doc.status,
queryable: doc.queryable,
latestDefinitionVersion: doc.latestDefinitionVersion,
latestDefinition: doc.latestDefinition,
statusDetail: doc.statusDetail,
synonymMappingStatus: doc.synonymMappingStatus,
synonymMappingStatusDetail: doc.synonymMappingStatusDetail,
}));

return {
Expand All @@ -51,7 +54,17 @@ export class CollectionSearchIndexesTool extends MongoDBToolBase {
},
...(indexes.map((indexDefinition) => {
return {
text: `\nName: "${indexDefinition.name}"\nDefinition: ${JSON.stringify(indexDefinition.latestDefinition, null, 2)}\n`,
text: [
`Name: "${indexDefinition.name}"`,
`Definition: ${JSON.stringify(indexDefinition.latestDefinition, null, 2)}`,
`Queryable: ${indexDefinition.queryable}`,
`Status: "${indexDefinition.status}"`,
`Status Detail: ${JSON.stringify(indexDefinition.statusDetail, null, 2)}`,
`Definition Version: ${JSON.stringify(indexDefinition.latestDefinitionVersion, null, 2)}`,
`Synonym Mapping Status: ${indexDefinition.synonymMappingStatus}`,
`Synonym Mapping Status Detail: ${JSON.stringify(indexDefinition.synonymMappingStatusDetail, null, 2)}`,
`ID: ${indexDefinition.id}`,
].join("\n"),
type: "text",
};
}) as { text: string; type: "text" }[]),
Expand Down
Loading