neograph::Tool Class Reference

Abstract base class for tools that agents can call. More...

#include <tool.h>

Inheritance diagram for neograph::Tool:

Public Member Functions
virtual std::string	execute (const json &arguments)=0
	Execute the tool with the given arguments.
virtual asio::awaitable< std::string >	execute_async (const json &arguments)
	Canonical async entry point for tool execution.
virtual ChatTool	get_definition () const =0
	Get the tool definition metadata.
virtual std::string	get_name () const =0
	Get the tool name.

Detailed Description

Abstract base class for tools that agents can call.

A tool provides its definition (name, description, parameter schema) so the LLM knows when and how to call it, and an execute() method that performs the actual work.

See also

neograph::mcp::MCPTool for remote MCP server tools.

Definition at line 114 of file tool.h.

Member Function Documentation

execute()

virtual std::string neograph::Tool::execute ( const json &  arguments )

pure virtual

Execute the tool with the given arguments.

Parameters

arguments

JSON object containing the tool's input parameters.

Returns

Result string to be fed back to the LLM.

Implemented in neograph::AsyncTool.

execute_async()

virtual asio::awaitable< std::string > neograph::Tool::execute_async ( const json &  arguments )

virtual

Canonical async entry point for tool execution.

The default offloads the sync execute() implementation to NeoGraph's bounded blocking pool, so a legacy synchronous tool no longer pins the graph event loop or serializes unrelated tool calls. I/O-bound tools (HTTP fetch, MCP RPC) override this with a real coroutine. Dispatchers apply ToolExecutionController policy before calling either path.

Reimplemented in neograph::mcp::MCPTool, and neograph::AsyncTool.

get_definition()

virtual ChatTool neograph::Tool::get_definition ( ) const

pure virtual

Get the tool definition metadata.

Returns a ChatTool containing the tool's name, description, and JSON Schema for its parameters. This is sent to the LLM so it can decide when to call the tool.

Returns

Tool definition including name, description, and parameter schema.

Implemented in neograph::mcp::MCPTool.

get_name()

virtual std::string neograph::Tool::get_name ( ) const

pure virtual

Get the tool name.

Returns

Tool name string (must match the name in get_definition()).

Implemented in neograph::mcp::MCPTool.

---

The documentation for this class was generated from the following file:

• include/neograph/tool.h