Chroma Mcp Server
Overview
What is Chroma?
Chroma is an open-source project designed to provide a powerful and flexible MCP (Minecraft: Java Edition) server. It allows players to experience Minecraft in a unique way, offering various features that enhance gameplay and server management. The project is hosted on GitHub under the user "privetin" and is publicly accessible for contributions and improvements.
Features of Chroma
- Customizable Server Settings: Chroma allows server administrators to customize various settings to tailor the gameplay experience to their liking.
- User-Friendly Interface: The project comes with a user-friendly interface that simplifies server management and configuration.
- Active Community Support: Being an open-source project, Chroma benefits from an active community that contributes to its development and provides support to users.
- Regular Updates: The project is regularly updated to fix bugs, improve performance, and add new features, ensuring a smooth gaming experience.
- Compatibility: Chroma is designed to be compatible with various Minecraft versions, making it versatile for different player bases.
How to Use Chroma
- Installation: To get started with Chroma, download the latest release from the GitHub repository. Follow the installation instructions provided in the documentation.
- Configuration: After installation, configure the server settings according to your preferences. This includes setting up player permissions, game modes, and other server parameters.
- Launching the Server: Once configured, launch the server and invite players to join. Ensure that your server is running the correct version of Minecraft for compatibility.
- Community Engagement: Engage with the Chroma community on GitHub for support, feature requests, and contributions. You can report issues, suggest improvements, or even contribute code.
Frequently Asked Questions
Q: Is Chroma free to use?
A: Yes, Chroma is an open-source project and is free to use for everyone.
Q: How can I contribute to Chroma?
A: You can contribute by reporting issues, suggesting features, or submitting code changes via pull requests on the GitHub repository.
Q: What versions of Minecraft does Chroma support?
A: Chroma is designed to be compatible with multiple versions of Minecraft. Always check the documentation for the latest compatibility information.
Q: Where can I find support for Chroma?
A: Support can be found in the GitHub repository's issues section, where you can ask questions and report problems. Additionally, community forums may provide further assistance.
Q: Can I customize the gameplay experience on my Chroma server?
A: Absolutely! Chroma offers extensive customization options to tailor the gameplay experience to your liking.
Details
Chroma MCP Server
A Model Context Protocol (MCP) server implementation that provides vector database capabilities through Chroma. This server enables semantic document search, metadata filtering, and document management with persistent storage.
Requirements
- Python 3.8+
- Chroma 0.4.0+
- MCP SDK 0.1.0+
Components
Resources
The server provides document storage and retrieval through Chroma's vector database:
- Stores documents with content and metadata
- Persists data in
src/chroma/data
directory - Supports semantic similarity search
Tools
The server implements CRUD operations and search functionality:
Document Management
-
create_document
: Create a new document- Required:
document_id
,content
- Optional:
metadata
(key-value pairs) - Returns: Success confirmation
- Error: Already exists, Invalid input
- Required:
-
read_document
: Retrieve a document by ID- Required:
document_id
- Returns: Document content and metadata
- Error: Not found
- Required:
-
update_document
: Update an existing document- Required:
document_id
,content
- Optional:
metadata
- Returns: Success confirmation
- Error: Not found, Invalid input
- Required:
-
delete_document
: Remove a document- Required:
document_id
- Returns: Success confirmation
- Error: Not found
- Required:
-
list_documents
: List all documents- Optional:
limit
,offset
- Returns: List of documents with content and metadata
- Optional:
Search Operations
search_similar
: Find semantically similar documents- Required:
query
- Optional:
num_results
,metadata_filter
,content_filter
- Returns: Ranked list of similar documents with distance scores
- Error: Invalid filter
- Required:
Features
- Semantic Search: Find documents based on meaning using Chroma's embeddings
- Metadata Filtering: Filter search results by metadata fields
- Content Filtering: Additional filtering based on document content
- Persistent Storage: Data persists in local directory between server restarts
- Error Handling: Comprehensive error handling with clear messages
- Retry Logic: Automatic retries for transient failures
Installation
- Install dependencies:
uv venv
uv sync --dev --all-extras
Configuration
Claude Desktop
Add the server configuration to your Claude Desktop config:
Windows: C:\Users\<username>\AppData\Roaming\Claude\claude_desktop_config.json
MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
{
"mcpServers": {
"chroma": {
"command": "uv",
"args": [
"--directory",
"C:/MCP/server/community/chroma",
"run",
"chroma"
]
}
}
}
Data Storage
The server stores data in:
- Windows:
src/chroma/data
- MacOS/Linux:
src/chroma/data
Usage
- Start the server:
uv run chroma
- Use MCP tools to interact with the server:
### Create a document
create_document({
"document_id": "ml_paper1",
"content": "Convolutional neural networks improve image recognition accuracy.",
"metadata": {
"year": 2020,
"field": "computer vision",
"complexity": "advanced"
}
})
### Search similar documents
search_similar({
"query": "machine learning models",
"num_results": 2,
"metadata_filter": {
"year": 2020,
"field": "computer vision"
}
})
Error Handling
The server provides clear error messages for common scenarios:
Document already exists [id=X]
Document not found [id=X]
Invalid input: Missing document_id or content
Invalid filter
Operation failed: [details]
Development
Testing
- Run the MCP Inspector for interactive testing:
npx @modelcontextprotocol/inspector uv --directory C:/MCP/server/community/chroma run chroma
- Use the inspector's web interface to:
- Test CRUD operations
- Verify search functionality
- Check error handling
- Monitor server logs
Building
- Update dependencies:
uv compile pyproject.toml
- Build package:
uv build
Contributing
Contributions are welcome! Please read our Contributing Guidelines for details on:
- Code style
- Testing requirements
- Pull request process
License
This project is licensed under the MIT License - see the LICENSE file for details.
Server Config
{
"mcpServers": {
"chroma": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/metorial/mcp-container--privetin--chroma--chroma",
"chroma"
],
"env": {}
}
}
}