Back to Genai Toolbox

arcadedb-execute-cypher Tool

docs/en/integrations/arcadedb/tools/arcadedb-execute-cypher.md

1.7.01.5 KB
Original Source

About

arcadedb-execute-cypher executes an arbitrary Cypher query against an ArcadeDB source over the Bolt protocol. It supports a readOnly mode that rejects write statements and a dry_run mode that validates queries without executing them.

Note: This tool is intended for developer assistant workflows with human-in-the-loop and shouldn't be used for production agents.

Compatible Sources

{{< compatible-sources >}}

Example

yaml
kind: tool
name: query_arcadedb
type: arcadedb-execute-cypher
source: my-arcadedb-source
readOnly: true
description: |
  Execute Cypher against ArcadeDB in read-only mode.
  Example:
  {{
      "cypher": "MATCH (n) RETURN count(n)"
  }}

Reference

fieldtyperequireddescription
typestringtrueMust be "arcadedb-execute-cypher".
sourcestringtrueName of the ArcadeDB source the Cypher query should execute on.
descriptionstringtrueDescription of the tool that is passed to the LLM.
readOnlybooleanfalseIf set to true, the tool will reject any write operations in the Cypher query. Default is false.