Skip to content

Tool

Plugin ID: eca_tool:eca_tool

Available since: 1.0.0

Provided tokens

Token Description
[user] The current user.
Alias: current_user
[htmx] Information about the current HTMX request.
[htmx:is_request] Whether the current request was sent by HTMX ("1" or "0").
[htmx:boosted] Whether the current request was boosted by HTMX ("1" or "0").
[htmx:history_restore] Whether the current request is for HTMX history restoration ("1" or "0").
[htmx:target] The value of the HX-Target request header.
[htmx:trigger] The value of the HX-Trigger request header.
[htmx:trigger_name] The value of the HX-Trigger-Name request header.
[htmx:current_url] The value of the HX-Current-URL request header.
[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 — config key: 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.

Type: textarea · Required: yes · Default: empty string

Arguments — config key: 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.

Type: textarea · Required: no · Default: empty string