Skip to main content

Virtual Tool

Declare one tool callable by an AI::VirtualAgent (or exposed externally via AI::MCPEndpoint). Each property defined on the tool becomes a typed output connector — when the model invokes the tool, the matching argument is sent on that connector and the downstream branch executes with the value.

Parameters

NameREQUIRED

Tool name shown to the model. Must be unique within the parent VirtualAgent / MCPEndpoint.

DescriptionREQUIRED

Plain-language description of what the tool does. The model reads this to decide when to call the tool — keep it concrete and unambiguous.

PropertiesREQUIRED

Arguments the model must (or may) provide when invoking the tool. Each property has: - Name — argument key, also the output connector key. - TypeText, Integer, or JSON. - Required — when true the model must provide a value. - Format — optional format hint (e.g. email, uri, date-time) sent to the model. - Enum values — optional list of allowed values; the model is constrained to pick from these. - Default — optional default value supplied to the downstream branch when the model omits the argument.

Input

ToolREQUIRED

Connection back to the parent AI::VirtualAgent or AI::MCPEndpoint that exposes this tool.

Output

One output connector per declared property — typed according to the property's type and labeled with the property name. Downstream nodes wire to the arguments they care about.