Package com.axelor.ai.tool.builder

Class SaveToolTool

java.lang.Object

com.axelor.ai.tool.builder.SaveToolTool

All Implemented Interfaces:

SystemTool<SaveToolTool.Input>

public class SaveToolTool
extends Object
implements SystemTool<SaveToolTool.Input>

Creates or updates a tool by code: a script, an HTTP endpoint, an action, or a system tool the application registers.

A new tool is saved disabled and asking for approval (invariant 3): an administrator reads its script or endpoint and enables it. An existing one keeps its state, so rewriting an enabled script puts it live once the save is approved — the card says so. Secrets are never an input (invariant 4): a header or query parameter that carries a credential must reference one as ${secret.NAME}, and the administrator fills it on the tool's form. MCP tools come from their server and client tools from the browser: neither is written here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SaveToolTool.Input

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE

Method Summary

Modifier and Type	Method	Description
ToolResult	beforeApproval(SaveToolTool.Input input, ToolContext context)	Looked at before the user is asked to approve a call, for a tool that needs approval: a refusal known up front should not cost the user a decision.
String	callTitle(SaveToolTool.Input input, String name)	What to call one call of this tool, given what it was called with.
String	code()	Unique code matching AiTool.systemTool field.
String	description()	Brief description of what this tool does.
ToolResult	execute(SaveToolTool.Input input, ToolContext context)	Execute with the given typed input and agent-scoped context.
Class<SaveToolTool.Input>	inputType()	The input record class.
String	name()	Human-readable display name (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.axelor.ai.tool.system.SystemTool

provideContext, refusal, runsOutsideTransaction, safety, undoneByRollback

Field Details

CODE

public static final String CODE

See Also:

• Constant Field Values

Method Details

code

public String code()

Description copied from interface: SystemTool

Unique code matching AiTool.systemTool field.

Specified by:

code in interface SystemTool<SaveToolTool.Input>

name

public String name()

Description copied from interface: SystemTool

Human-readable display name (e.g. "Search Records").

Specified by:

name in interface SystemTool<SaveToolTool.Input>

description

public String description()

Description copied from interface: SystemTool

Brief description of what this tool does.

Specified by:

description in interface SystemTool<SaveToolTool.Input>

inputType

public Class<SaveToolTool.Input> inputType()

Description copied from interface: SystemTool

The input record class. Return Void.class for tools with no input.

Specified by:

inputType in interface SystemTool<SaveToolTool.Input>

callTitle

public String callTitle(SaveToolTool.Input input,
 String name)

Description copied from interface: SystemTool

What to call one call of this tool, given what it was called with.

One call of a tool is not like the next: a tool that takes one record or several cannot be named accurately by its configuration alone. The name it is configured with is passed in, and returning it — as the default does — is what leaves the tool named the way the administrator named it.

Specified by:

callTitle in interface SystemTool<SaveToolTool.Input>

Parameters:

input - the call's input, or null when the tool takes none

name - the tool's configured display name

beforeApproval

public ToolResult beforeApproval(SaveToolTool.Input input,
 ToolContext context)

Description copied from interface: SystemTool

Looked at before the user is asked to approve a call, for a tool that needs approval: a refusal known up front should not cost the user a decision. Return an ToolResult.Error to refuse the call without asking, a ToolResult.PendingApproval to ask with what its card should show, or null to ask as usual. The call itself checks again when it runs.

Specified by:

beforeApproval in interface SystemTool<SaveToolTool.Input>

Parameters:

input - the call's input, or null when the tool takes none

context - the call's context

execute

public ToolResult execute(SaveToolTool.Input input,
 ToolContext context)

Description copied from interface: SystemTool

Execute with the given typed input and agent-scoped context.

Specified by:

execute in interface SystemTool<SaveToolTool.Input>