Skip to content

ECA Tool

Available since: 2.1.11

Provided tokens

Token Description
[event] The event.
[event:machine_name] The machine name of the ECA event.
[VARIOUS] All tokens forwarded by the dispatcher.
[session_user] The user account that dispatched the event, regardless if ECA is processing models under a different account. This is only available if ECA is configured to always run under a specific account.

Fields

Description

Summarizes what this tool is for. This plain text property is particularly important to the AI agent because it provides context and explicitly defines the use case using natural language.

Arguments

The arguments that the AI agent passes into the tool. They must be written in YAML format. This property is also important to the AI agent. Note that the top-level keys (e.g. node, user) become the names of the tokens that are then available to successors of this event.

Provide the list of arguments in YAML format so that the caller of this tool know which context need to be made available:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
node:
  data_type: "entity:node:article"
  label: "The article to process"
  required: true
  description: "The article that should be investigated in the format {node:nid}, so for example node:2."
user:
  data_type: "entity:user"
  label: "The user"
  required: true
  description: "Provide the user in the format {user:uid} so that their name can be determined and verified if they are the author of the article, e.g. user:5."

Each argument has a name, e.g. "node" or "user" in the above example. For each of them, provide the data type, a label, a description, and a flag whether that argument is required or not.

Those arguments will be available as tokens to the subsequent conditions and actions following that event.