Package io.agentscope.core.agui.model

Class AguiTool

java.lang.Object

io.agentscope.core.agui.model.AguiTool

public class AguiTool
extends Object

Represents a tool definition in the AG-UI protocol.

Tools are functions that the agent can call to perform actions or retrieve information. This class defines the tool's interface including its name, description, and parameter schema.

Constructor Summary

Constructors

Constructor	Description
AguiTool(String name, String description, Map<String,Object> parameters)	Creates a new AguiTool.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	Get the tool description.
String	getName()	Get the tool name.
Map<String,Object>	getParameters()	Get the parameters JSON Schema.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AguiTool

public AguiTool(String name,
 String description,
 Map<String,Object> parameters)

Creates a new AguiTool.

Parameters:

name - The tool name

description - The tool description

parameters - The parameters JSON Schema

Method Details

getName

public String getName()

Get the tool name.

Returns:

The tool name

getDescription

public String getDescription()

Get the tool description.

Returns:

The tool description

getParameters

public Map<String,Object> getParameters()

Get the parameters JSON Schema.

Returns:

The parameters schema as an immutable map

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object