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.1.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.1.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for mcp_neo4j_aura_manager-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d7504283889b7ca0489768ceb033f8659c3000c9a82a866b805ddd296a1975b7
MD5 ea98705b24668760eec205867723fe7f
BLAKE2b-256 be09142918a58c7def1a16957479682243f93f010c6e837674cb1b64ab87c1d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_neo4j_aura_manager-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f361b4d09e7fc2e40d9b62f0668cad659651e3d1dcdba8c0a16d96014ace496
MD5 d9594c1bd1e9026ed21d9bb1822f2363
BLAKE2b-256 874a72945f50bfe05bbbf43cad876aa3aa2f05c8aacbc8b19ed06fa0c913f2a5

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