Package com.axelor.ai.tool.meta

Class ListModelsTool

java.lang.Object

com.axelor.ai.tool.meta.ListModelsTool

All Implemented Interfaces:

SystemTool<ListModelsTool.Input>

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

Lists model names the current agent may read for its user. The list is also auto-injected into the system prompt via provideContext() so the LLM can map business terms to correct model names without an explicit tool call.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ListModelsTool.Input

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE

Constructor Summary

Constructors

Constructor	Description
ListModelsTool()

Method Summary

Modifier and Type	Method	Description
String	code()	Unique code matching AiTool.systemTool field.
String	description()	Brief description of what this tool does.
ToolResult	execute(ListModelsTool.Input input, ToolContext context)	Execute with the given typed input and agent-scoped context.
Class<ListModelsTool.Input>	inputType()	The input record class.
String	name()	Human-readable display name (e.g.
String	provideContext()	Provides context text to inject into the system prompt at request time, avoiding the need for the LLM to call this tool just to learn the current state.
ToolSafety	safety()	Safety classification for approval decisions.

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

beforeApproval, callTitle, refusal, runsOutsideTransaction, undoneByRollback

Field Details

CODE

public static final String CODE

See Also:

• Constant Field Values

Constructor Details

ListModelsTool

public ListModelsTool()

Method Details

code

public String code()

Description copied from interface: SystemTool

Unique code matching AiTool.systemTool field.

Specified by:

code in interface SystemTool<ListModelsTool.Input>

name

public String name()

Description copied from interface: SystemTool

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

Specified by:

name in interface SystemTool<ListModelsTool.Input>

description

public String description()

Description copied from interface: SystemTool

Brief description of what this tool does.

Specified by:

description in interface SystemTool<ListModelsTool.Input>

inputType

public Class<ListModelsTool.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<ListModelsTool.Input>

safety

public ToolSafety safety()

Description copied from interface: SystemTool

Safety classification for approval decisions. Tools default to ToolSafety.WRITE. Override to ToolSafety.READ_ONLY for safe tools that never require approval or ToolSafety.DESTRUCTIVE for tools that should always require approval.

Specified by:

safety in interface SystemTool<ListModelsTool.Input>

execute

public ToolResult execute(ListModelsTool.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<ListModelsTool.Input>

provideContext

public String provideContext()

Description copied from interface: SystemTool

Provides context text to inject into the system prompt at request time, avoiding the need for the LLM to call this tool just to learn the current state.

Called automatically for each tool assigned to the agent before the LLM runs. Return null (the default) if this tool has no context to provide.

Specified by:

provideContext in interface SystemTool<ListModelsTool.Input>

Returns:

context text to append to the system prompt, or null