1. Set Required Environment Variables
Before proceeding, set these variables with your Neo4j Aura API credentials:NEO4J_AURA_CLIENT_ID
– Your Neo4j Aura API client IDNEO4J_AURA_CLIENT_SECRET
– Your Neo4j Aura API client secret
2. Install Meshagent
3. Sign Up & Authenticate
Register and sign in with Meshagent using the CLI:Meshagent CLI Getting Started
4. Launch the MCP Server in a Test Room
- This command starts a Meshagent Room called
test
and launches the MCP server as an agent in that room. - The Room (and the services within) are automatically shut down when inactive.
5. Start the Chatbot in the Same Room
- This joins a chatbot to the same room, enabling chat-based interaction with the MCP tools.
- The output will provide a room link.
6. Interact via Browser
Open the provided room link in your browser and send a message to the agent to interact with Neo4j Cloud Aura tools. All resources (agents, chatbots, and the MCP server) will be removed when the room closes.Project Level Deployment
For persistent services that are automatically available in all project rooms (recommended for production), deploy as follows:1. Deploy the Persistent MCP Server Service
2. Deploy the Persistent Chatbot Service
Tools Available
Summary
These tools enable robust management of Neo4j Aura database instances through the Meshagent platform:Tool | Description |
---|---|
create_instance | Create instance |
delete_instance | Delete instance |
get_instance_by_name | Find instance by name |
get_instance_details | Get instance details |
get_tenant_details | Get tenant details |
list_instances | List all Neo4j Aura database instances |
list_tenants | List tenants |
pause_instance | Pause instance |
resume_instance | Resume instance |
update_instance_memory | Update instance memory |
update_instance_name | Update instance name |
update_instance_vector_optimization | Update instance vector optimization |
Tool Details
create_instance
Create a new Neo4j Aura database instanceParameters:
name
(string): Name for the new instance (required)tenant_id
(string): ID of the tenant/project (required)cloud_provider
(string, optional): Cloud provider (gcp, aws, azure)graph_analytics_plugin
(boolean, optional): Enable graph analytics pluginmemory
(integer, optional): Memory allocation in GBregion
(string, optional): Region for the instance (e.g., ‘us-central1’)source_instance_id
(string, optional): Source instance to clone fromtype
(string, optional): Instance type (free-db, professional-db, etc.)vector_optimized
(boolean, optional): Enable vector optimization (requires >4GB memory)
delete_instance
Delete a Neo4j Aura database instanceParameters:
instance_id
(string): ID of the instance to delete
get_instance_by_name
Find a Neo4j Aura instance by name and return its detailsParameters:
name
(string): Name of the instance
get_instance_details
Get details for one or more Neo4j Aura instances by IDParameters:
instance_ids
(array): List of instance IDs
get_tenant_details
Get details for a specific Neo4j Aura tenant/projectParameters:
tenant_id
(string): ID of the tenant/project
list_instances
List all Neo4j Aura database instances
list_tenants
List all Neo4j Aura tenants/projects
pause_instance
Pause a Neo4j Aura database instanceParameters:
instance_id
(string): ID of the instance
resume_instance
Resume a paused Neo4j Aura database instanceParameters:
instance_id
(string): ID of the instance
update_instance_memory
Update the memory allocation of a Neo4j Aura instanceParameters:
instance_id
(string): ID of the instancememory
(integer): New memory allocation in GB
update_instance_name
Update the name of a Neo4j Aura instanceParameters:
instance_id
(string): ID of the instancename
(string): New name
update_instance_vector_optimization
Update the vector optimization setting of a Neo4j Aura instanceParameters:
instance_id
(string): ID of the instancevector_optimized
(boolean): Enable vector optimization