|
| 1 | +# Neo4j Cloud Aura Api MCP Server |
| 2 | + |
| 3 | +Manage Neo4j Aura database instances through the Neo4j Aura API. |
| 4 | + |
| 5 | +[What is an MCP Server?](https://www.anthropic.com/news/model-context-protocol) |
| 6 | + |
| 7 | +## Characteristics |
| 8 | +Attribute|Details| |
| 9 | +|-|-| |
| 10 | +**Image Source**|Official Image |
| 11 | +**Docker Image**|[mcp/neo4j-cloud-aura-api](https://hub.docker.com/repository/docker/mcp/neo4j-cloud-aura-api) |
| 12 | +**Author**|[neo4j-contrib](https://github.com/neo4j-contrib) |
| 13 | +**Repository**|https://github.com/neo4j-contrib/mcp-neo4j |
| 14 | +**Dockerfile**|https://github.com/neo4j-contrib/mcp-neo4j/blob/main/servers/mcp-neo4j-cloud-aura-api/Dockerfile |
| 15 | +**Docker Image built by**|Docker Inc. |
| 16 | +**Docker Scout Health Score**|  |
| 17 | +**Verify Signature**|`COSIGN_REPOSITORY=mcp/signatures cosign verify mcp/neo4j-cloud-aura-api --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub` |
| 18 | +**Licence**|MIT License |
| 19 | + |
| 20 | +## Available Tools |
| 21 | +Tools provided by this Server|Short Description |
| 22 | +-|- |
| 23 | +`create_instance`|Create a new Neo4j Aura database instance| |
| 24 | +`delete_instance`|Delete a Neo4j Aura database instance| |
| 25 | +`get_instance_by_name`|Find a Neo4j Aura instance by name and returns the details including the id| |
| 26 | +`get_instance_details`|Get details for one or more Neo4j Aura instances by ID, including status, region, memory, storage| |
| 27 | +`get_tenant_details`|Get details for a specific Neo4j Aura tenant/project| |
| 28 | +`list_instances`|List all Neo4j Aura database instances| |
| 29 | +`list_tenants`|List all Neo4j Aura tenants/projects| |
| 30 | +`pause_instance`|Pause a Neo4j Aura database instance| |
| 31 | +`resume_instance`|Resume a paused Neo4j Aura database instance| |
| 32 | +`update_instance_memory`|Update the memory allocation of a Neo4j Aura instance| |
| 33 | +`update_instance_name`|Update the name of a Neo4j Aura instance| |
| 34 | +`update_instance_vector_optimization`|Update the vector optimization setting of a Neo4j Aura instance| |
| 35 | + |
| 36 | +--- |
| 37 | +## Tools Details |
| 38 | + |
| 39 | +#### Tool: **`create_instance`** |
| 40 | +Create a new Neo4j Aura database instance |
| 41 | +Parameters|Type|Description |
| 42 | +-|-|- |
| 43 | +`name`|`string`|Name for the new instance |
| 44 | +`tenant_id`|`string`|ID of the tenant/project where the instance will be created |
| 45 | +`cloud_provider`|`string` *optional*|Cloud provider (gcp, aws, azure) |
| 46 | +`graph_analytics_plugin`|`boolean` *optional*|Whether to enable the graph analytics plugin |
| 47 | +`memory`|`integer` *optional*|Memory allocation in GB |
| 48 | +`region`|`string` *optional*|Region for the instance (e.g., 'us-central1') |
| 49 | +`source_instance_id`|`string` *optional*|ID of the source instance to clone from (for professional/enterprise instances) |
| 50 | +`type`|`string` *optional*|Instance type (free-db, professional-db, enterprise-db, or business-critical) |
| 51 | +`vector_optimized`|`boolean` *optional*|Whether the instance is optimized for vector operations. Only allowed for instance with more than 4GB memory. |
| 52 | + |
| 53 | +--- |
| 54 | +#### Tool: **`delete_instance`** |
| 55 | +Delete a Neo4j Aura database instance |
| 56 | +Parameters|Type|Description |
| 57 | +-|-|- |
| 58 | +`instance_id`|`string`|ID of the instance to delete |
| 59 | + |
| 60 | +--- |
| 61 | +#### Tool: **`get_instance_by_name`** |
| 62 | +Find a Neo4j Aura instance by name and returns the details including the id |
| 63 | +Parameters|Type|Description |
| 64 | +-|-|- |
| 65 | +`name`|`string`|Name of the instance to find |
| 66 | + |
| 67 | +--- |
| 68 | +#### Tool: **`get_instance_details`** |
| 69 | +Get details for one or more Neo4j Aura instances by ID, including status, region, memory, storage |
| 70 | +Parameters|Type|Description |
| 71 | +-|-|- |
| 72 | +`instance_ids`|`array`|List of instance IDs to retrieve |
| 73 | + |
| 74 | +--- |
| 75 | +#### Tool: **`get_tenant_details`** |
| 76 | +Get details for a specific Neo4j Aura tenant/project |
| 77 | +Parameters|Type|Description |
| 78 | +-|-|- |
| 79 | +`tenant_id`|`string`|ID of the tenant/project to retrieve |
| 80 | + |
| 81 | +--- |
| 82 | +#### Tool: **`list_instances`** |
| 83 | +List all Neo4j Aura database instances |
| 84 | +#### Tool: **`list_tenants`** |
| 85 | +List all Neo4j Aura tenants/projects |
| 86 | +#### Tool: **`pause_instance`** |
| 87 | +Pause a Neo4j Aura database instance |
| 88 | +Parameters|Type|Description |
| 89 | +-|-|- |
| 90 | +`instance_id`|`string`|ID of the instance to pause |
| 91 | + |
| 92 | +--- |
| 93 | +#### Tool: **`resume_instance`** |
| 94 | +Resume a paused Neo4j Aura database instance |
| 95 | +Parameters|Type|Description |
| 96 | +-|-|- |
| 97 | +`instance_id`|`string`|ID of the instance to resume |
| 98 | + |
| 99 | +--- |
| 100 | +#### Tool: **`update_instance_memory`** |
| 101 | +Update the memory allocation of a Neo4j Aura instance |
| 102 | +Parameters|Type|Description |
| 103 | +-|-|- |
| 104 | +`instance_id`|`string`|ID of the instance to update |
| 105 | +`memory`|`integer`|New memory allocation in GB |
| 106 | + |
| 107 | +--- |
| 108 | +#### Tool: **`update_instance_name`** |
| 109 | +Update the name of a Neo4j Aura instance |
| 110 | +Parameters|Type|Description |
| 111 | +-|-|- |
| 112 | +`instance_id`|`string`|ID of the instance to update |
| 113 | +`name`|`string`|New name for the instance |
| 114 | + |
| 115 | +--- |
| 116 | +#### Tool: **`update_instance_vector_optimization`** |
| 117 | +Update the vector optimization setting of a Neo4j Aura instance |
| 118 | +Parameters|Type|Description |
| 119 | +-|-|- |
| 120 | +`instance_id`|`string`|ID of the instance to update |
| 121 | +`vector_optimized`|`boolean`|Whether the instance should be optimized for vector operations |
| 122 | + |
| 123 | +--- |
| 124 | +## Use this MCP Server |
| 125 | + |
| 126 | +```json |
| 127 | +{ |
| 128 | + "mcpServers": { |
| 129 | + "neo4j-cloud-aura-api": { |
| 130 | + "command": "docker", |
| 131 | + "args": [ |
| 132 | + "run", |
| 133 | + "-i", |
| 134 | + "--rm", |
| 135 | + "-e", |
| 136 | + "NEO4J_AURA_CLIENT_ID", |
| 137 | + "-e", |
| 138 | + "NEO4J_AURA_CLIENT_SECRET", |
| 139 | + "mcp/neo4j-cloud-aura-api" |
| 140 | + ], |
| 141 | + "env": { |
| 142 | + "NEO4J_AURA_CLIENT_ID": "<your-client-id>", |
| 143 | + "NEO4J_AURA_CLIENT_SECRET": "<your-client-secret>" |
| 144 | + } |
| 145 | + } |
| 146 | + } |
| 147 | +} |
| 148 | +``` |
| 149 | + |
| 150 | +[Why is it safer to run MCP Servers with Docker?](https://www.docker.com/blog/the-model-context-protocol-simplifying-building-ai-apps-with-anthropic-claude-desktop-and-docker/) |
0 commit comments