autogen.tools.Tool

Tool

Tool(
    *,
    name: str | None = None,
    description: str | None = None,
    func_or_tool: ForwardRef('Tool') | Callable[..., Any],
    parameters_json_schema: dict[str, Any] | None = None
)

A class representing a Tool that can be used by an agent for various tasks.
This class encapsulates a tool with a name, description, and an executable function.
The tool can be registered with a ConversableAgent for use either with an LLM or for direct execution.
Attributes:
name (str): The name of the tool.
description (str): The description of the tool.
func_or_tool (Union[Tool, Callable[…, Any]]): The function or Tool instance to create a Tool from.
parameters_json_schema (Optional[ict[str, Any]]): A schema describing the parameters that the function accepts. If None, the schema will be generated from the function signature.
Create a new Tool object.

Parameters:

Name	Description
name	Type: str | None Default: None
description	Type: str | None Default: None
func_or_tool	Type: ForwardRef(‘Tool’) | Callable[…, Any]
parameters_json_schema	Type: dict[str, typing.Any] | None Default: None

Instance Attributes

description

func

function_schema

Get the schema for the function.
This is the old way of handling function calls with OpenAI and compatible frameworks.
It is provided for backward compatibility.

name

realtime_tool_schema

Get the schema for the tool.
This is the preferred way of handling function calls with OpeaAI and compatible frameworks.

tool_schema

Get the schema for the tool.
This is the preferred way of handling function calls with OpeaAI and compatible frameworks.

Instance Methods

register_for_execution

register_for_execution(self, agent: ConversableAgent) -> 

Registers the tool for direct execution by a ConversableAgent.
This method registers the tool so that it can be executed by the agent, typically outside of the context of an LLM interaction.

Parameters:

Name	Description
agent	The agent to which the tool will be registered. Type: ConversableAgent

register_for_llm

register_for_llm(self, agent: ConversableAgent) -> 

Registers the tool for use with a ConversableAgent’s language model (LLM).
This method registers the tool so that it can be invoked by the agent during interactions with the language model.

Parameters:

Name	Description
agent	The agent to which the tool will be registered. Type: ConversableAgent

register_tool

register_tool(self, agent: ConversableAgent) -> 

Register a tool to be both proposed and executed by an agent.
Equivalent to calling both register_for_llm and register_for_execution with the same agent.
Note: This will not make the agent recommend and execute the call in the one step. If the agent recommends the tool, it will need to be the next agent to speak in order to execute the tool.

Parameters:

Name	Description
agent	The agent to which the tool will be registered. Type: ConversableAgent