agents::Tool Class Reference

Interface for tools that an agent can use. More...

#include <tool.h>

Inheritance diagram for agents::Tool:

Public Member Functions
	Tool (const std::string &name, const std::string &description)
	Constructor.
	Tool (const std::string &name, const std::string &description, const JsonObject &parameters)
	Construct a new Tool object.
virtual	~Tool ()=default
	Destructor.
const std::string &	getName () const
	Get the name of the tool.
const std::string &	getDescription () const
	Get the description of the tool.
const ParameterMap &	getParameters () const
	Get the parameters of the tool.
const JsonObject &	getSchema () const
	Get the schema of the tool.
void	addParameter (const Parameter &param)
	Add a parameter to the tool.
void	addParametersFromJson (const JsonObject &params)
	Add tool parameters from json definition.
void	setCallback (ToolCallback callback)
	Set the execution callback.
virtual ToolResult	execute (const JsonObject &params) const
	Execute the tool with the given parameters.
virtual double	scoreRelevance (const std::string &query) const
	Score the relevance of this tool to a given query.
bool	validateParameters (const JsonObject &params) const
	Validate parameters against schema.

Detailed Description

Interface for tools that an agent can use.

Tools are capabilities that the LLM can use to interact with the outside world. Each tool has a name, description, set of parameters, and execution logic.

Constructor & Destructor Documentation

Tool() [1/2]

agents::Tool::Tool	(	const std::string &	name,
		const std::string &	description )

Constructor.

Parameters

name	The name of the tool
description	The description of the tool

Tool() [2/2]

agents::Tool::Tool	(	const std::string &	name,
		const std::string &	description,
		const JsonObject &	parameters )

Construct a new Tool object.

Parameters

name	The name of the tool
description	The description of the tool
parameters	The json parameters of the tool

Member Function Documentation

addParameter()

void agents::Tool::addParameter

(

const Parameter &

param

)

Add a parameter to the tool.

Parameters

param

The parameter to add

addParametersFromJson()

void agents::Tool::addParametersFromJson

(

const JsonObject &

params

)

Add tool parameters from json definition.

Parameters

params

The parameters to add

execute()

virtual ToolResult agents::Tool::execute ( const JsonObject & params ) const

virtual

Execute the tool with the given parameters.

Parameters

params

The parameters to execute the tool with

Returns

The result of the tool execution

Reimplemented in agents::MCPTool, agents::skills::MarkdownSkillTool, agents::tools::BraveSearchTool, agents::tools::CalculatorTool, agents::tools::DatetimeTool, agents::tools::FetchWebpageTool, agents::tools::FileReadTool, agents::tools::FileWriteTool, agents::tools::MediaLoaderTool, agents::tools::PythonTool, agents::tools::ShellCommandTool, agents::tools::WeatherTool, agents::tools::WebSearchTool, and agents::tools::WikipediaTool.

getDescription()

const std::string & agents::Tool::getDescription

(

)

const

Get the description of the tool.

Returns

The description of the tool

getName()

const std::string & agents::Tool::getName

(

)

const

Get the name of the tool.

Returns

The name of the tool

getParameters()

const ParameterMap & agents::Tool::getParameters

(

)

const

Get the parameters of the tool.

Returns

The parameters of the tool

getSchema()

const JsonObject & agents::Tool::getSchema

(

)

const

Get the schema of the tool.

Returns

The schema of the tool

scoreRelevance()

virtual double agents::Tool::scoreRelevance ( const std::string & query ) const

virtual

Score the relevance of this tool to a given query.

Parameters

query

The query to score against

Returns

double Relevance score (0.0 to 1.0)

Reimplemented in agents::skills::MarkdownSkillTool.

setCallback()

void agents::Tool::setCallback

(

ToolCallback

callback

)

Set the execution callback.

Parameters

callback

The callback to set

validateParameters()

bool agents::Tool::validateParameters

(

const JsonObject &

params

)

const

Validate parameters against schema.

Parameters

params

The parameters to validate

Returns

true of valid, otherwise false