You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/genai-ecosystem/pages/aura-agent-getting-started.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -515,7 +515,7 @@ You've successfully built and deployed a knowledge graph agent using Neo4j Aura
515
515
516
516
== Resources
517
517
518
-
* See the http://neo4j.com/docs/aura/aura-agent/[documentation^] for a more in-depth details on Neo4j Aura Agent
518
+
* See the https://neo4j.com/docs/aura/aura-agent/[documentation^] for a more in-depth details on Neo4j Aura Agent
519
519
* Additional worked examples are continually added to the https://github.com/neo4j-product-examples/knowledge-graph-agent[GitHub Repository^]
520
520
* The https://neo4j.com/product/aura-agent/[Neo4j Aura Agent webpage^] and https://neo4j.com/developer/genai-ecosystem/aura-agent/[developer guide^] contains a general overview with links to additional videos and learning resources
Aura Agent, in early access from Oct 2025, is an agent-creation platform that enables users to rapidly build, test, and deploy AI agents grounded by their own enterprise data in AuraDB.
Neo4j Aura Agent, is an agent-creation platform that enables users to rapidly build, test, and deploy AI agents grounded by their own enterprise data in https://neo4j.com/product/auradb/[AuraDB].
12
14
It provides end-to-end automated orchestration and AIOps for graph-based knowledge retrieval.
13
15
The platform abstracts away the complexity of integrating diverse LLM and agentic frameworks, GraphRAG retrieval patterns, text-to-query generation (via specialized Text2Cypher models), and secure agent-serving infrastructure.
* *Graph-Driven Agent Creation*: Auto-generate a ready-to-deploy draft agent in minutes with tailored prompts and tools customized to your graph schema and use case(s).
* *Rapid Testing & Iteration*: Test, refine, and evaluate agent behavior in a built-in low-code playground UI. Easily add, remove, and edit tools.
26
+
* *Advanced Reasoning & Explainability*: Enhance trust with transparent chain-of-thought and multi-hop graph reasoning exposed through Neo4j Aura Agent's reasoning tab and response format
27
+
* *Single-Click Deployment (MCP & REST)*: Simplify your AI stack with secure, hosted, MCP & REST endpoints in the cloud
16
28
17
-
Among the key capabilities of Aura Agent:
29
+
Watch the 5-minute demo for details!
18
30
19
-
* Agent creation in the Aura console with a no-/low-code agent builder
20
-
* Agent retrieval tools for pre-defined graph query templates, vector similarity search, and text to query
21
-
* Agent testing via a playground chat UI
22
-
* Secure agent deployment for consumption by downstream apps via an authenticated endpoint, with MCP support coming soon
You can use Aura Agent with the following Aura offerings
35
+
You can use neo4j Aura Agent with the following Aura offerings
27
36
28
37
* AuraDB Free
29
38
* AuraDB Pro (incl. Pro Trial)
@@ -34,123 +43,26 @@ The database must not be paused to use it in an agent.
34
43
You need to have *"Generative AI assistance" enabled* in your Aura Organization, then Aura Agents should be visible in the sidebar.
35
44
36
45
== Getting Started
46
+
See the xref:aura-agent-getting-started.adoc[getting started tutorial] and https://neo4j.com/docs/aura/aura-agent/[documentation]
47
+
to understand how to begin using Neo4j Aura Agent.
37
48
38
-
Navigate to the Agents entry in the sidebar, select "Create Agent" and provide
39
-
40
-
* Title
41
-
* Description
42
-
* Instructions
43
-
44
-
And most critically your Aura database to run on (requirements see above).
45
-
46
-
You can test your agent continually in the chat on the right hand side.
47
-
48
-
Then start adding *specific tools* to your agent to give it the capabilities to retrieve certain subsets of data or convert user questions into Cypher queries.
49
-
Currently the agent only supports _read only_ queries against the database.
50
-
51
-
Don't forget to save your agent, when you're satisfied with the current state.
You can choose to share your agent internally with other project members, or make it available *externally* through an API (currentl REST, soon MCP and A2A).
56
-
57
-
== Available Tools
58
-
59
-
=== Cypher Template Tool
60
-
61
-
The *Cypher Template Tool*, executes a parameterized, read-only Cypher statement against the database and returns the results directly to the agent.
62
-
63
-
You need to provide a _name_ and _description_ of the tool for the agent to use and _cypher_ query and an optional set of parameters.
64
-
65
-
Some notes:
66
-
67
-
* make sure to return only relevant information from the query
68
-
* best return only select node and relationship attributes (text, numbers)
69
-
* don't return embeddings or graph elements like node / relationship / paths
70
-
* try to de-duplicate the results
71
-
* limit the results to 10 to 50 rows so that the agent/LLM is not overwhelmed with too much irrelevant information
72
-
* test the Cypher statements of your tools beforehand to ensure that they work correctly
The "Text2Cypher" allows the agent to retrieve data dynamically that is either not covered by other tools or more structural in nature (like aggregations).
79
-
80
-
The infrastructure will pass the _text from the tool invocation_, together with the retrieved database _schema_ and the _text2cypher system prompt_ to a fine-tuned model to generate a suitable Cypher statement to execute.
81
-
82
-
For this tool you only need to provide a _description_ and _instructions_.
83
-
84
-
The instructions should cover:
85
-
86
-
* When to use the Text2Cypher tool (and when not)
87
-
* Specific aspects about your database, domain
88
-
* Relevant entities and especially information about searchable categorical properties, e.g. shape of identifiers
89
-
* Which attributes are suitable for aggregation
90
-
91
-
=== Vector Similarity Tool
92
-
93
-
The *Vector Similarity Tool* allows to find nodes in your graph by vector similarity.
94
-
95
-
Besides a description you provide
96
-
97
-
* Embedding Model Provider (Vertex AI, OpenAI)
98
-
* Embedding Model
99
-
* Vector Index Name
100
-
* Top-K results
101
-
102
-
And the tool will then embed the input text from the agent, perform the vector search and return the top-k results to the agent for processing.
103
-
104
-
== API Usage
105
-
106
-
To integrate the Aura Agent into your system, you can make it available externally, so it is callable via a REST API.
107
-
108
-
Besides the `ENDPOINT_URL` you also need `CLIENT_ID` and `CLIENT_SECRET` as https://neo4j.com/docs/aura/aura-cli/initial-configuration/[API keys from your User Profile^], to create short lived session tokens.
109
-
110
-
The example code below uses https://jqlang.org/[`jq`] for command line JSON processing.
See the https://github.com/neo4j-product-examples/knowledge-graph-agent/[Worked Examples Repository^] for applying Aura Agent to various use cases including:
144
51
145
-
The example repository contains example code for https://github.com/neo4j-product-examples/knowledge-graph-agent/tree/main/code/contract-review-mcp[wrapping the REST API into an MCP server].
0 commit comments