MCP server for Weaviate vector database operations
Project description
Weaviate MCP Server
A Model Context Protocol (MCP) server that provides seamless integration with Weaviate vector databases. This server focuses on powerful search capabilities including semantic, keyword, and hybrid search, with plans to expand functionality in future releases.
Features
The Weaviate MCP Server currently provides 11 essential tools for interacting with your Weaviate instance:
Connection & Configuration
get_config- View current Weaviate configuration (with sensitive values masked)check_connection- Test connection to your Weaviate instance
Schema & Collection Management
list_collections- List all available collections in your databaseget_schema- Get detailed schema information for specific collections or all collectionsget_collection_objects- Retrieve objects from collections with pagination support
Search Capabilities (Primary Focus)
search- Simplified search interface using hybrid search by defaultsemantic_search- Vector similarity search using embeddings for semantic matchingkeyword_search- BM25-based keyword search for exact term matchinghybrid_search- Combined semantic and keyword search with configurable weighting
Multi-Tenancy Support
is_multi_tenancy_enabled- Check if a collection supports multi-tenancyget_tenant_list- List all tenants for a multi-tenant collection
Installation
Using pip
pip install mcp-weaviate
Using uv (recommended)
uv add mcp-weaviate
From source
git clone https://github.com/yourusername/mcp-weaviate.git
cd mcp-weaviate
uv sync
Requirements
- Python 3.12 or higher
- Weaviate instance (local or cloud)
- API keys for embeddings:
- OpenAI API key (for OpenAI embeddings)
- Cohere API key (optional, for Cohere embeddings)
Configuration
MCP Settings Configuration
Add the Weaviate MCP server to your MCP settings file (typically claude_desktop_config.json or similar):
Local Weaviate Instance
{
"mcpServers": {
"mcp-weaviate": {
"command": "/path/to/uv",
"args": [
"--directory",
"/path/to/mcp-weaviate",
"run",
"python",
"run_mcp_weaviate.py",
"--connection-type", "local",
"--host", "localhost",
"--port", "8080",
"--grpc-port", "50051",
"--openai-api-key", "YOUR_OPENAI_API_KEY"
]
}
}
}
Weaviate Cloud Services
{
"mcpServers": {
"mcp-weaviate": {
"command": "/path/to/uv",
"args": [
"--directory",
"/path/to/mcp-weaviate",
"run",
"python",
"run_mcp_weaviate.py",
"--connection-type", "cloud",
"--cluster-url", "https://your-cluster.weaviate.network",
"--api-key", "YOUR_WEAVIATE_API_KEY",
"--openai-api-key", "YOUR_OPENAI_API_KEY"
]
}
}
}
Using Environment Variables (Recommended)
For better security, use environment variables for sensitive values:
{
"mcpServers": {
"mcp-weaviate": {
"command": "/path/to/uv",
"args": [
"--directory",
"/path/to/mcp-weaviate",
"run",
"python",
"run_mcp_weaviate.py",
"--connection-type", "cloud"
],
"env": {
"WEAVIATE_CLUSTER_URL": "https://your-cluster.weaviate.network",
"WEAVIATE_API_KEY": "YOUR_WEAVIATE_API_KEY",
"OPENAI_API_KEY": "YOUR_OPENAI_API_KEY",
"COHERE_API_KEY": "YOUR_COHERE_API_KEY"
}
}
}
}
Configuration Options
| Option | Description | Default | Environment Variable |
|---|---|---|---|
--connection-type |
Connection type: "local" or "cloud" | local | - |
--host |
Host for local connection | localhost | - |
--port |
HTTP port for local connection | 8080 | - |
--grpc-port |
gRPC port for local connection | 50051 | - |
--cluster-url |
Weaviate Cloud Services URL | - | WEAVIATE_CLUSTER_URL |
--api-key |
API key for authentication | - | WEAVIATE_API_KEY |
--openai-api-key |
OpenAI API key for embeddings | - | OPENAI_API_KEY |
--cohere-api-key |
Cohere API key for embeddings | - | COHERE_API_KEY |
--timeout-init |
Initialization timeout (seconds) | 30 | - |
--timeout-query |
Query timeout (seconds) | 60 | - |
--timeout-insert |
Insert timeout (seconds) | 120 | - |
Getting Started
1. Set up your Weaviate instance
For local development using Docker:
docker run -d \
--name weaviate \
-p 8080:8080 \
-p 50051:50051 \
--env AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED='true' \
--env PERSISTENCE_DATA_PATH='/var/lib/weaviate' \
--env QUERY_DEFAULTS_LIMIT=25 \
--env DEFAULT_VECTORIZER_MODULE='text2vec-openai' \
--env ENABLE_MODULES='text2vec-openai' \
--env CLUSTER_HOSTNAME='node1' \
cr.weaviate.io/semitechnologies/weaviate:latest
2. Configure the MCP server
Add the configuration to your MCP settings as shown above.
3. Test the connection
Once configured, you can test the connection using the MCP client:
# Check connection status
result = await mcp.call_tool("check_connection")
print(result) # {"connected": true, "connection_type": "local", "host": "localhost"}
# List available collections
collections = await mcp.call_tool("list_collections")
print(collections) # {"collections": ["Article", "Product"], "total": 2}
Usage Examples
Basic Search
# Simple search (uses hybrid search by default)
results = await mcp.call_tool("search", {
"query": "machine learning applications",
"collection_name": "Article",
"limit": 5
})
Semantic Search
# Find semantically similar content
results = await mcp.call_tool("semantic_search", {
"query": "artificial intelligence in healthcare",
"collection_name": "Article",
"limit": 10
})
Keyword Search
# Exact keyword matching with BM25
results = await mcp.call_tool("keyword_search", {
"query": "Python programming",
"collection_name": "Tutorial",
"limit": 5
})
Hybrid Search with Custom Weighting
# Balance between semantic and keyword search
results = await mcp.call_tool("hybrid_search", {
"query": "climate change effects",
"collection_name": "Research",
"alpha": 0.7, # 70% semantic, 30% keyword
"limit": 10
})
Working with Multi-Tenant Collections
# Check if collection supports multi-tenancy
status = await mcp.call_tool("is_multi_tenancy_enabled", {
"collection_name": "UserDocuments"
})
# Get list of tenants
tenants = await mcp.call_tool("get_tenant_list", {
"collection_name": "UserDocuments"
})
# Search within a specific tenant
results = await mcp.call_tool("search", {
"query": "project proposals",
"collection_name": "UserDocuments",
"tenant_id": "tenant-123",
"limit": 5
})
Schema Inspection
# Get schema for a specific collection
schema = await mcp.call_tool("get_schema", {
"collection_name": "Product"
})
# Get complete database schema
full_schema = await mcp.call_tool("get_schema")
Tool Reference
Search Tools
search
Simplified search interface using hybrid search with balanced defaults (alpha=0.3).
semantic_search
Vector similarity search using embeddings. Best for finding conceptually similar content.
keyword_search
BM25 keyword search for exact term matching. Best for finding specific terms or phrases.
hybrid_search
Combines semantic and keyword search using Reciprocal Rank Fusion (RRF).
alphaparameter controls the balance:- 1.0 = 100% semantic search
- 0.0 = 100% keyword search
- 0.5 = equal weight
- 0.3 = default (30% semantic, 70% keyword)
Collection Management
get_collection_objects
Retrieve objects from a collection with pagination support:
limit: Maximum number of objects to returnoffset: Number of objects to skip (for pagination)
Multi-Tenancy
All search and retrieval tools support an optional tenant_id parameter for multi-tenant collections.
Roadmap
The Weaviate MCP Server currently focuses on comprehensive search capabilities. Future releases will include:
-
Data Management
- Object creation and updates
- Batch imports
- Delete operations
-
Advanced Query Features
- Filtering and where clauses
- Aggregations
- GraphQL query support
-
Collection Management
- Create/modify collections
- Index management
- Backup and restore operations
-
Enhanced Search
- Generative search (RAG)
- Question answering
- Custom ranking functions
Development
Setting up for development
# Clone the repository
git clone https://github.com/yourusername/mcp-weaviate.git
cd mcp-weaviate
# Install dependencies with uv
uv sync
# Install development dependencies
uv sync --dev
# Run tests
uv run pytest
# Run linting
uv run ruff check .
# Run type checking
uv run mypy .
Running locally
# Run the MCP server directly
uv run python run_mcp_weaviate.py --connection-type local
# Or with all options
uv run python run_mcp_weaviate.py \
--connection-type cloud \
--cluster-url https://your-cluster.weaviate.network \
--api-key YOUR_API_KEY \
--openai-api-key YOUR_OPENAI_KEY
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
MIT License - see LICENSE file for details.
Support
For issues, questions, or suggestions, please open an issue on the GitHub repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcp_weaviate-0.1.0.tar.gz.
File metadata
- Download URL: mcp_weaviate-0.1.0.tar.gz
- Upload date:
- Size: 74.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e45a0ed778b0f4c92c54937156e14fe3ff6b9af096702cd7be14396710d6c160
|
|
| MD5 |
0b267784a38d8dc59c0112ca133306a8
|
|
| BLAKE2b-256 |
5bad851b4308568663b0220fc4e5e9001654427987801d2f38e50e14aefcd0b8
|
File details
Details for the file mcp_weaviate-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mcp_weaviate-0.1.0-py3-none-any.whl
- Upload date:
- Size: 14.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
192eac591c6b85fa81a4a74e2458089f130d7b34e7fe5bf4efa4488381893fe7
|
|
| MD5 |
c3c6e85126db3eaae8d7db4ce878396a
|
|
| BLAKE2b-256 |
0a3e4e791ba892ce871a583a01919847a71a8f22c55d3defe22f335990fb8aca
|