-
Notifications
You must be signed in to change notification settings - Fork 123
Add MongoDB Assistant Tools #472
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
Conversation
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 introduces MongoDB Assistant tools for the MCP server, enabling natural language search and knowledge source discovery. It adds integration with the MongoDB Assistant AI chatbot and search service.
- Scaffolds a new
AssistantToolBaseclass for MongoDB Assistant tool interactions - Implements two initial tools:
list_knowledge_sourcesandsearch_knowledge - Adds comprehensive test coverage with mocked API responses
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/common/config.ts | Adds assistantBaseUrl configuration option |
| src/tools/tool.ts | Extends ToolCategory type to include "assistant" |
| src/tools/assistant/assistantTool.ts | Base class for Assistant tools with common functionality |
| src/tools/assistant/list_knowledge_sources.ts | Tool for listing available knowledge sources |
| src/tools/assistant/search_knowledge.ts | Tool for searching the knowledge base |
| src/tools/assistant/tools.ts | Exports array of Assistant tools |
| src/server.ts | Registers Assistant tools with the server |
| tests/integration/helpers.ts | Updates response element types to support metadata |
| tests/integration/tools/assistant/assistantHelpers.ts | Test utilities for Assistant tool testing |
| tests/integration/tools/assistant/listKnowledgeSources.test.ts | Integration tests for list knowledge sources tool |
| tests/integration/tools/assistant/searchKnowledge.test.ts | Integration tests for search knowledge tool |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Not sure what if anything I should have here - would appreciate advice from the DevTools team on this.
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.
The TelemetryToolMetadata type seems to track a specific Atlas org/project but the assistant is not associated with a given Atlas instance. Planning to leave this empty unless someone has a good idea of what to put here.
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.
can we try to use the apiClient to make this call? do you need specific headers or can you leverage that to make requests? Check getIpInfo in that file for a customized call
Also, is this page not authenticated?
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.
It looks like the apiClient is specifically for talking to Atlas/MMS APIs? The knowledge APIs are a distinct server so I don't think it will work for this.
do you need specific headers
Yeah we must include, at minimum, a user-agent + origin or x-request-origin header
is this page not authenticated
correct - the knowledge API is not authenticated
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.
can we instead return content instead of throwing an exception? we've been changing this across the code. it's better to have the tool return a response but with the proper messaging
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.
Yes! Updated for both assistant tools.
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.
since we're here, can we also update the readme.md? there we call out all the tool categories
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.
You don't need this if you're not adding any special error handling.
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.
Can we abstract this and move it to the base tool? Essentially, expose a function like:
protected function fetchKnowledgeBase<T>(method: "GET" | "POST", path: string, body?: unknown): Promise<T>
that calls fetch, parses the response, logs errors, etc. Additionally, we tend to prefer working with pure typescript types rather than zod schemas for API calls. Those are easier to reason about and more succinct to type.
Proposed changes
(EAI-1266) Knowledge Search on MCP
Adds a new class of
Assistanttools for interacting with the MongoDB Assistant (AI Chatbot + Search).This PR scaffolds the generic
AssistantToolBaseclass as well as two initial tools:list_knowledge_sources- pulls a list of all available data sources. Useful for knowing what data is available and for filtering thesearch_knowledgesearch_knowledge- runs a natural language search against the MongoDB Assistant knowledge base. Returns content chunks for the most relevant results.Checklist