MCP Neo4j Aura Database Instance Manager
Project description
๐๐โ๏ธ Neo4j Aura Database Manager MCP Server
mcp-name: io.github.neo4j-contrib/mcp-neo4j-aura-manager
๐ Overview
A Model Context Protocol (MCP) server implementation that provides tools for managing Neo4j Aura database instances through the Neo4j Aura API.
This server allows you to create, monitor, and manage Neo4j Aura instances directly through Claude, making it easy to provision and maintain your graph database infrastructure.
๐ Authentication
Authentication with the Neo4j Aura API requires:
- Client ID
- Client Secret
You can obtain these credentials from the Neo4j Aura console, see the documentation of the Aura API
Here is the API Specification
๐ฆ Components
๐ง Tools
The server offers these core tools:
๐ ๏ธ Instance Management
-
list_instances- List all Neo4j Aura database instances
- No input required
- Returns: List of all instances with their details
-
get_instance_details- Get details for a specific instance or multiple instances by ID
- Input:
instance_ids(string or array): ID of the instance to retrieve, or array of instance IDs
- Returns: Detailed information about the instance(s)
-
get_instance_by_name- Find an instance by name
- Input:
name(string): Name of the instance to find
- Returns: Instance details if found
-
create_instance- Create a new Neo4j Aura database instance
- Input:
tenant_id(string): ID of the tenant/project where the instance will be createdname(string): Name for the new instancememory(integer): Memory allocation in GBregion(string): Region for the instance (e.g., 'us-east-1')version(string): Neo4j version (e.g., '5.15')type(string, optional): Instance type (enterprise or professional)vector_optimized(boolean, optional): Whether the instance is optimized for vector operations
- Returns: Created instance details
-
update_instance_name- Update the name of an instance
- Input:
instance_id(string): ID of the instance to updatename(string): New name for the instance
- Returns: Updated instance details
-
update_instance_memory- Update the memory allocation of an instance
- Input:
instance_id(string): ID of the instance to updatememory(integer): New memory allocation in GB
- Returns: Updated instance details
-
update_instance_vector_optimization- Update the vector optimization setting of an instance
- Input:
instance_id(string): ID of the instance to updatevector_optimized(boolean): Whether the instance should be optimized for vector operations
- Returns: Updated instance details
-
pause_instance- Pause a database instance
- Input:
instance_id(string): ID of the instance to pause
- Returns: Instance status information
-
resume_instance- Resume a paused database instance
- Input:
instance_id(string): ID of the instance to resume
- Returns: Instance status information
-
delete_instance- Delete a database instance
- Input:
tenant_id(string): ID of the tenant/project where the instance existsinstance_id(string): ID of the instance to delete
- Returns: Deletion status information
๐ข Tenant/Project Management
-
list_tenants- List all Neo4j Aura tenants/projects
- No input required
- Returns: List of all tenants with their details
-
get_tenant_details- Get details for a specific tenant/project
- Input:
tenant_id(string): ID of the tenant/project to retrieve
- Returns: Detailed information about the tenant/project
๐ง Usage with Claude Desktop
๐พ Installation
pip install mcp-neo4j-aura-manager
โ๏ธ Configuration
Add the server to your claude_desktop_config.json:
"mcpServers": {
"neo4j-aura": {
"command": "uvx",
"args": [
"mcp-neo4j-aura-manager@0.4.4",
"--client-id",
"<your-client-id>",
"--client-secret",
"<your-client-secret>"
]
}
}
Alternatively, you can set environment variables:
"mcpServers": {
"neo4j-aura": {
"command": "uvx",
"args": [ "mcp-neo4j-aura-manager@0.4.4" ],
"env": {
"NEO4J_AURA_CLIENT_ID": "<your-client-id>",
"NEO4J_AURA_CLIENT_SECRET": "<your-client-secret>"
}
}
}
๐ณ Using with Docker
"mcpServers": {
"neo4j-aura": {
"command": "docker",
"args": [
"run",
"--rm",
"-e", "NEO4J_AURA_CLIENT_ID=${NEO4J_AURA_CLIENT_ID}",
"-e", "NEO4J_AURA_CLIENT_SECRET=${NEO4J_AURA_CLIENT_SECRET}",
"mcp-neo4j-aura-manager:0.4.4"
]
}
}
๐ท๏ธ Namespacing for Multi-tenant Deployments
The server supports namespacing to prefix tool names for multi-tenant deployments:
"mcpServers": {
"neo4j-aura-app1": {
"command": "uvx",
"args": [
"mcp-neo4j-aura-manager@0.4.4",
"--client-id", "<your-client-id>",
"--client-secret", "<your-client-secret>",
"--namespace", "app1"
]
},
"neo4j-aura-app2": {
"command": "uvx",
"args": [
"mcp-neo4j-aura-manager@0.4.4",
"--client-id", "<your-client-id>",
"--client-secret", "<your-client-secret>",
"--namespace", "app2"
]
}
}
CLI Usage
# With namespace
mcp-neo4j-aura-manager --client-id <id> --client-secret <secret> --namespace myapp
# Tools become: myapp-list_instances, myapp-create_instance, etc.
Environment Variables
export NEO4J_AURA_CLIENT_ID=your_client_id
export NEO4J_AURA_CLIENT_SECRET=your_client_secret
export NEO4J_NAMESPACE=myapp
mcp-neo4j-aura-manager
Docker with Namespacing
docker run -e NEO4J_AURA_CLIENT_ID=<id> \
-e NEO4J_AURA_CLIENT_SECRET=<secret> \
-e NEO4J_NAMESPACE=myapp \
mcp-neo4j-aura-manager
๐ HTTP Transport Mode
The server supports HTTP transport for web-based deployments and microservices:
# Basic HTTP mode (defaults: host=127.0.0.1, port=8000, path=/mcp/)
mcp-neo4j-aura-manager --transport http
# Custom HTTP configuration
mcp-neo4j-aura-manager --transport http --host 127.0.0.1 --port 8080 --path /api/mcp/
Environment variables for HTTP configuration:
export NEO4J_TRANSPORT=http
export NEO4J_MCP_SERVER_HOST=127.0.0.1
export NEO4J_MCP_SERVER_PORT=8080
export NEO4J_MCP_SERVER_PATH=/api/mcp/
export NEO4J_MCP_SERVER_ALLOWED_HOSTS="localhost,127.0.0.1"
export NEO4J_MCP_SERVER_ALLOW_ORIGINS="http://localhost:3000"
export NEO4J_NAMESPACE=myapp
mcp-neo4j-aura-manager
๐ Transport Modes
The server supports three transport modes:
- STDIO (default): Standard input/output for local tools and Claude Desktop
- SSE: Server-Sent Events for web-based deployments
- HTTP: Streamable HTTP for modern web deployments and microservices
๐ Security Protection
The server includes comprehensive security protection with secure defaults that protect against common web-based attacks while preserving full MCP functionality when using HTTP transport.
๐ก๏ธ DNS Rebinding Protection
TrustedHost Middleware validates Host headers to prevent DNS rebinding attacks:
Secure by Default:
- Only
localhostand127.0.0.1hosts are allowed by default - Malicious websites cannot trick browsers into accessing your local server
Environment Variable:
export NEO4J_MCP_SERVER_ALLOWED_HOSTS="example.com,www.example.com"
๐ CORS Protection
Cross-Origin Resource Sharing (CORS) protection blocks browser-based requests by default:
Environment Variable:
export NEO4J_MCP_SERVER_ALLOW_ORIGINS="https://example.com,https://example.com"
๐ง Complete Security Configuration
Development Setup:
mcp-neo4j-aura-manager --transport http \
--allowed-hosts "localhost,127.0.0.1" \
--allow-origins "http://localhost:3000"
Production Setup:
mcp-neo4j-aura-manager --transport http \
--allowed-hosts "example.com,www.example.com" \
--allow-origins "https://example.com,https://example.com"
๐จ Security Best Practices
For allow_origins:
- Be specific:
["https://example.com", "https://example.com"] - Never use
"*"in production with credentials - Use HTTPS origins in production
For allowed_hosts:
- Include your actual domain:
["example.com", "www.example.com"] - Include localhost only for development
- Never use
"*"unless you understand the risks
๐ณ Docker Deployment
The Neo4j Aura Manager MCP server can be deployed using Docker for remote deployments. Docker deployment should use HTTP transport for web accessibility. In order to integrate this deployment with applications like Claude Desktop, you will have to use a proxy in your MCP configuration such as mcp-remote.
๐ณ Using with Docker for Claude Desktop
Here we use the Docker Hub hosted Aura Manager MCP server image with stdio transport for use with Claude Desktop.
Config details:
-i: Interactive mode - keeps STDIN open for stdio transport communication--rm: Automatically remove container when it exits (cleanup)-p 8000:8000: Port mapping - maps host port 8000 to container port 8000NEO4J_TRANSPORT=stdio: Uses stdio transport for Claude Desktop compatibilityNEO4J_AURA_CLIENT_IDandNEO4J_AURA_CLIENT_SECRET: Your Aura API credentials
{
"mcpServers": {
"neo4j-aura": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-p",
"8000:8000",
"-e", "NEO4J_AURA_CLIENT_ID=your-client-id",
"-e", "NEO4J_AURA_CLIENT_SECRET=your-client-secret",
"-e", "NEO4J_TRANSPORT=stdio",
"mcp/neo4j-aura-manager:latest"
]
}
}
}
๐ฆ Using Your Built Image
After building locally with docker build -t mcp-neo4j-aura-manager:latest .:
# Build the image
docker build -t mcp-neo4j-aura-manager:<version> .
# Run with http transport (default for Docker)
docker run --rm -p 8000:8000 \
-e NEO4J_AURA_CLIENT_ID="your-client-id" \
-e NEO4J_AURA_CLIENT_SECRET="your-client-secret" \
-e NEO4J_TRANSPORT="http" \
-e NEO4J_MCP_SERVER_HOST="0.0.0.0" \
-e NEO4J_MCP_SERVER_PORT="8000" \
-e NEO4J_MCP_SERVER_PATH="/mcp/" \
mcp-neo4j-aura-manager:<version>
# Run with security middleware for production
docker run --rm -p 8000:8000 \
-e NEO4J_AURA_CLIENT_ID="your-client-id" \
-e NEO4J_AURA_CLIENT_SECRET="your-client-secret" \
-e NEO4J_TRANSPORT="http" \
-e NEO4J_MCP_SERVER_HOST="0.0.0.0" \
-e NEO4J_MCP_SERVER_PORT="8000" \
-e NEO4J_MCP_SERVER_PATH="/mcp/" \
-e NEO4J_MCP_SERVER_ALLOWED_HOSTS="example.com,www.example.com" \
-e NEO4J_MCP_SERVER_ALLOW_ORIGINS="https://example.com" \
mcp-neo4j-aura-manager:<version>
๐ง Environment Variables
| Variable | Default | Description |
|---|---|---|
NEO4J_AURA_CLIENT_ID |
(none) | Neo4j Aura API Client ID |
NEO4J_AURA_CLIENT_SECRET |
(none) | Neo4j Aura API Client Secret |
NEO4J_TRANSPORT |
stdio (local), http (remote) |
Transport protocol (stdio, http, or sse) |
NEO4J_MCP_SERVER_HOST |
127.0.0.1 (local) |
Host to bind to |
NEO4J_MCP_SERVER_PORT |
8000 |
Port for HTTP/SSE transport |
NEO4J_MCP_SERVER_PATH |
/mcp/ |
Path for accessing MCP server |
NEO4J_MCP_SERVER_ALLOW_ORIGINS |
(empty - secure by default) | Comma-separated list of allowed CORS origins |
NEO4J_MCP_SERVER_ALLOWED_HOSTS |
localhost,127.0.0.1 |
Comma-separated list of allowed hosts (DNS rebinding protection) |
NEO4J_NAMESPACE |
(empty - no prefix) | Namespace prefix for tool names (e.g., myapp-list_instances) |
๐ SSE Transport for Legacy Web Access
When using SSE transport (for legacy web clients), the server exposes an HTTP endpoint:
# Start the server with SSE transport
docker run -d -p 8000:8000 \
-e NEO4J_AURA_CLIENT_ID="your-client-id" \
-e NEO4J_AURA_CLIENT_SECRET="your-client-secret" \
-e NEO4J_TRANSPORT="sse" \
-e NEO4J_MCP_SERVER_HOST="0.0.0.0" \
-e NEO4J_MCP_SERVER_PORT="8000" \
--name neo4j-aura-mcp-server \
mcp-neo4j-aura-manager:latest
# Test the SSE endpoint
curl http://localhost:8000/sse
# Use with MCP Inspector
npx @modelcontextprotocol/inspector http://localhost:8000/sse
๐ Claude Desktop Integration with Docker
For Claude Desktop integration with a Dockerized server using http transport:
{
"mcpServers": {
"neo4j-aura-docker": {
"command": "npx",
"args": ["-y", "mcp-remote@latest", "http://localhost:8000/mcp/"]
}
}
}
Note: First start your Docker container with HTTP transport, then Claude Desktop can connect to it via the HTTP endpoint and proxy server like mcp-remote.
๐ Usage Examples
๐ Give overview over my tenants
๐ Find an instance by name
๐ List instances and find paused instance
โถ๏ธ Resume paused instances
โ Create a new instance
๐ Development
๐ฆ Prerequisites
- Install
uv(Universal Virtualenv):
# Using pip
pip install uv
# Using Homebrew on macOS
brew install uv
# Using cargo (Rust package manager)
cargo install uv
- Clone the repository and set up development environment:
# Clone the repository
git clone https://github.com/yourusername/mcp-neo4j-aura-manager.git
cd mcp-neo4j-aura-manager
# Create and activate virtual environment using uv
uv venv
source .venv/bin/activate # On Unix/macOS
.venv\Scripts\activate # On Windows
# Install dependencies including dev dependencies
uv pip install -e ".[dev]"
๐ License
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project 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_neo4j_aura_manager-0.4.4.tar.gz.
File metadata
- Download URL: mcp_neo4j_aura_manager-0.4.4.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
da73b8fd8db3142c0dfdb1014cd6701b1ca1ff78273bf4322567f85522034837
|
|
| MD5 |
640f1a0ead87f8c2f28237e4fa9210a8
|
|
| BLAKE2b-256 |
5ec691ea0ff4a2f0e898ff33260fa6dd34b69294dee761773b0bd1454b856485
|
File details
Details for the file mcp_neo4j_aura_manager-0.4.4-py3-none-any.whl.
File metadata
- Download URL: mcp_neo4j_aura_manager-0.4.4-py3-none-any.whl
- Upload date:
- Size: 15.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f1b6e48b96f84e357bb957e9af60bfe746d3fd434207ace092f87fc14dfd589a
|
|
| MD5 |
ca05c452fa14cad3490780424f061941
|
|
| BLAKE2b-256 |
6829094192c205563688856112282f774359cb7fb5b0263e87d9b06f137684cf
|