ChromaDB MCP Server
A Model Context Protocol (MCP) server that queries a local ChromaDB instance to provide relevant documents to GitHub Copilot.
Prerequisites
- Node.js (v18 or later)
- A running ChromaDB instance at
http://127.0.0.1:8000 - A collection named
ExchangeResearchin your ChromaDB instance
Installation
-
Install dependencies:
npm install -
Build the project:
npm run build
Configuration
The MCP server is configured in .vscode/settings.json to integrate with GitHub Copilot in VS Code.
To use it globally (across all projects), add this to your User Settings (settings.json):
{
"github.copilot.chat.mcp.servers": {
"chromadb": {
"command": "node",
"args": ["c:/source/chroma-mcp/build/index.js"]
}
}
}
Replace the path with the absolute path to your built index.js file.
Usage
Once configured, the MCP server will automatically start when you use GitHub Copilot in VS Code. You can use the query_chromadb tool in your Copilot conversations:
Example prompts:
- "Query ChromaDB for information about exchange APIs"
- "Search the ExchangeResearch collection for trading strategies"
- "Find documents related to market data"
The tool will automatically query your ChromaDB collection and provide relevant context to Copilot.
Tool Details
query_chromadb
Queries the ChromaDB ExchangeResearch collection for relevant documents.
Parameters:
query(required): The search query stringnResults(optional): Number of results to return (default: 5)
Returns: An array of documents with metadata and similarity distances.
Development
To rebuild the project after making changes:
npm run build
For continuous development with auto-rebuild:
npm run dev
Customization
To use a different ChromaDB URL or collection name, edit src/index.ts:
const chromaClient = new ChromaDbClient('http://127.0.0.1:8000', 'ExchangeResearch');
Troubleshooting
- Server not responding: Ensure ChromaDB is running at
http://127.0.0.1:8000 - Tool not appearing: Restart VS Code after adding the MCP configuration
- Build errors: Check that you have Node.js v18+ and run
npm installagain
This project is licensed under the MIT License.