-
Couldn't load subscription status.
- Fork 148
feat: add ability to create atlas search indexes #692
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.
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
base: main
Are you sure you want to change the base?
Conversation
e9cef48 to
3fab3b7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds support for creating Atlas Search (lexical) indexes through the MCP server. The changes enable users to create Atlas Search indexes with both dynamic and explicit field mappings, complementing the existing support for listing and dropping search indexes.
Key changes:
- Added Atlas Search index creation support to
create-indextool with comprehensive schema validation - Enhanced testing to differentiate between search and vector search indexes
- Added accuracy tests for various Atlas Search index creation scenarios
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/tools/mongodb/create/createIndex.ts |
Adds atlasSearchIndexDefinition schema and implements search index creation logic |
tests/integration/tools/mongodb/create/createIndex.test.ts |
Adds comprehensive integration tests for Atlas Search index creation scenarios |
tests/integration/tools/mongodb/delete/dropIndex.test.ts |
Refactors tests to handle both search and vector search indexes separately |
tests/accuracy/createIndex.test.ts |
Adds accuracy test cases for Atlas Search index creation with various configurations |
tests/accuracy/sdk/accuracyTestingClient.ts |
Removes deprecated --connectionString flag from CLI arguments |
README.md |
Updates documentation to remove deprecated --connectionString flag |
Comments suppressed due to low confidence (1)
tests/integration/tools/mongodb/create/createIndex.test.ts:1
- The index names are being evaluated at test definition time rather than test execution time. If
getSearchIndexName()andgetVectorIndexName()depend onbeforeEachsetup, these calls will execute before the setup runs, potentially returning undefined or stale values. Wrap these in functions:{ description: "search", indexName: () => getSearchIndexName() }and update the test to call the function.
import { describeWithMongoDB, validateAutoConnectBehavior, waitUntilSearchIsReady } from "../mongodbHelpers.js";
Pull Request Test Coverage Report for Build 18872159746Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
| import { quantizationEnum, similarityEnum } from "../../../common/search/vectorSearchEmbeddingsManager.js"; | ||
|
|
||
| export class CreateIndexTool extends MongoDBToolBase { | ||
| private vectorSearchIndexDefinition = z.object({ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is best viewed with the "Hide whitespace" option - it's just prettier reformatting the indents.
| }); | ||
|
|
||
| const args = [MCP_SERVER_CLI_SCRIPT, "--connectionString", mdbConnectionString, ...additionalArgs]; | ||
| const args = [MCP_SERVER_CLI_SCRIPT, mdbConnectionString, ...additionalArgs]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--connectionString is deprecated so using the positional argument.
Proposed changes
This adds support for creating atlas search indexes. Dropping and listing is already supported, so needed no changes.