Struct FunctionTool 

pub struct FunctionTool { /* private fields */ }

Available on crate feature tools only.

Implementations

impl FunctionTool

pub fn new<F, Fut>( name: impl Into<String>, description: impl Into<String>, handler: F, ) -> FunctionTool

where F: Fn(Arc<dyn ToolContext>, Value) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, AdkError>> + Send + 'static,

pub fn with_long_running(self, long_running: bool) -> FunctionTool

pub fn with_read_only(self, read_only: bool) -> FunctionTool

pub fn with_concurrency_safe(self, concurrency_safe: bool) -> FunctionTool

pub fn with_parameters_schema<T>(self) -> FunctionTool

where T: JsonSchema + Serialize,

pub fn with_response_schema<T>(self) -> FunctionTool

where T: JsonSchema + Serialize,

pub fn with_scopes(self, scopes: &[&'static str]) -> FunctionTool

Declare the scopes required to execute this tool.

When set, the framework will enforce that the calling user possesses all listed scopes before dispatching execute().

Example

let tool = FunctionTool::new("transfer", "Transfer funds", handler)
    .with_scopes(&["finance:write", "verified"]);

pub fn parameters_schema(&self) -> Option<&Value>

pub fn response_schema(&self) -> Option<&Value>

Trait Implementations

impl Tool for FunctionTool

fn enhanced_description(&self) -> String

Returns an enhanced description for long-running tools that includes a note warning the model not to call the tool again if it’s already pending.

fn name(&self) -> &str

fn description(&self) -> &str

fn is_long_running(&self) -> bool

Indicates whether the tool is a long-running operation. Long-running tools typically return a task ID immediately and complete the operation asynchronously.

fn is_read_only(&self) -> bool

Indicates whether this tool performs no side effects. Read-only tools may be executed concurrently in Auto mode.

fn is_concurrency_safe(&self) -> bool

Indicates whether this tool is safe for concurrent execution. Used by the Parallel strategy to validate dispatch safety.

fn parameters_schema(&self) -> Option<Value>

fn response_schema(&self) -> Option<Value>

fn required_scopes(&self) -> &[&str]

Returns the scopes required to execute this tool.

fn execute<'life0, 'async_trait>( &'life0 self, ctx: Arc<dyn ToolContext>, args: Value, ) -> Pin<Box<dyn Future<Output = Result<Value, AdkError>> + Send + 'async_trait>>

where 'life0: 'async_trait, FunctionTool: 'async_trait,

fn declaration(&self) -> Value

Returns the tool declaration that should be exposed to model providers.

fn is_builtin(&self) -> bool

Indicates whether this tool is a built-in server-side tool (e.g., google_search, url_context).