Click or drag to resize

AIToolConfiguration Properties

The AIToolConfiguration type exposes the following members.

Properties
 NameDescription
Public propertyCurrentToolCall Set by Execute(AIToolCall) immediately before the script runs so that the script can access the current call's arguments, id, and name via @Model.CurrentToolCall.
Public propertyDescription Human-readable description of what the tool does, shown to the AI model to help it decide when to call the tool.
Public propertyEffectiveExecutionScript Reads ExecutionScriptFile from Settings\AI\Scripts. Returns an empty string when no script file is configured.
Public propertyExecResult The script must assign the tool result string to this property. Execute(AIToolCall) returns this value after the Razor engine has run.
Public propertyExecutionScriptFile File name of a Razor/C# script file, relative to Settings\AI\Scripts.
Public propertyGUID Unique identifier for this tool configuration.
Public propertyIsEnabled When false, this tool is excluded from all agent calls without being deleted.
Public propertyName Unique function name sent to the AI model (e.g. get_report_data). Must contain only letters, digits, and underscores.
Public propertyParametersSchema JSON Schema string describing the function's parameters, sent to the AI model. Example: {"type":"object","properties":{"city":{"type":"string"}},"required":["city"]} Leave empty for tools that take no parameters.
Public propertyProgressLabel Friendly, end-user-facing text shown in the chat "thinking" panel while this tool runs, instead of the raw tool name. Supports {param} placeholders that are replaced by the matching argument values of the current call (e.g. Getting columns from table {table}). Translatable via the repository AIToolProgress context. Leave empty to fall back to a generic label built from the tool name.
Top
See Also