Skip to main content

MCP Neo4j Aura Database Instance Manager

Project description

Neo4j Aura Database Manager MCP Server

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 created
      • name (string): Name for the new instance
      • memory (integer): Memory allocation in GB
      • region (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 update
      • name (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 update
      • memory (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 update
      • vector_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 exists
      • instance_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",
      "--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" ],
    "env": {
      "NEO4J_AURA_CLIENT_ID": "<your-client-id>",
      "NEO4J_AURA_CLIENT_SECRET": "<your-client-secret>"
    }
  }
}

Development

For development, you can run the server directly:

"mcpServers": {
  "neo4j-aura": {
    "command": "uv",
      "args": [
        "--directory",
        "path/to/repo/src/mcp_neo4j_aura_manager",
        "run",
        "mcp-neo4j-aura-manager",
        "--client-id",
        "<your-client-id>",
        "--client-secret",
        "<your-client-secret>"
      ]
    }
}

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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_neo4j_aura_manager-0.2.0.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_neo4j_aura_manager-0.2.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file mcp_neo4j_aura_manager-0.2.0.tar.gz.

File metadata

File hashes

Hashes for mcp_neo4j_aura_manager-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5e6ae318404f3835f923ef1f853c70ca6ed4bd6fbbc097a1bc35979e00bb8a92
MD5 50f02f0521fe1de9424ffaead9a4c7c0
BLAKE2b-256 7a0d84c4b99a24d155a7e8e2f39b754b81290fbdfba0738e35c842879dfbbc10

See more details on using hashes here.

File details

Details for the file mcp_neo4j_aura_manager-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_neo4j_aura_manager-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8e128ca700d2c3bbe7c5a125feac078860c235b93fa4ec02daa75ad4b73171e
MD5 e06227fdbb0277da23382240b3382734
BLAKE2b-256 476e901553af16cc1dae34f159f43515ef377608ea979df48edb7428cdcbd384

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page