Struct AskTool 

pub struct AskTool { /* private fields */ }

Ask tool for user interaction

Allows the agent to ask questions to the user and receive responses. Supports:

• Free-form text questions
• Predefined options for selection
• Configurable timeout

Requirements: 6.1, 6.2, 6.3, 6.4, 6.5

Implementations

impl AskTool

pub fn new() -> Self

Create a new AskTool without a callback

Note: Without a callback, the tool will return an error when executed. Use with_callback to set up the user interaction handler.

pub fn with_callback(self, callback: AskCallback) -> Self

Set the callback for handling user questions

pub fn with_timeout(self, timeout: Duration) -> Self

Set the default timeout for user responses

pub fn has_callback(&self) -> bool

Check if a callback is configured

pub fn timeout(&self) -> Duration

Get the configured timeout

pub async fn ask( &self, question: &str, options: Option<&[AskOption]>, ) -> Result<AskResult, ToolError>

Ask a question to the user

This method invokes the callback with the question and optional options, and waits for the user’s response with timeout.

Arguments

• question - The question to ask
• options - Optional predefined options for the user to select from

Returns

• Ok(AskResult) - The user’s response
• Err(ToolError) - If no callback is configured, timeout occurs, or user cancels

Trait Implementations

impl Default for AskTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for AskTool

fn name(&self) -> &str

Returns the unique name of the tool

fn description(&self) -> &str

Returns a human-readable description of the tool

fn input_schema(&self) -> Value

Returns the JSON Schema for the tool’s input parameters

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, params: Value, _context: &'life1 ToolContext, ) -> Pin<Box<dyn Future<Output = Result<ToolResult, ToolError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the tool with the given parameters and context

fn check_permissions<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _params: &'life1 Value, _context: &'life2 ToolContext, ) -> Pin<Box<dyn Future<Output = PermissionCheckResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Check permissions before executing the tool

fn dynamic_description(&self) -> Option<String>

Returns a dynamically generated description of the tool

fn get_definition(&self) -> ToolDefinition

Get the tool definition for LLM consumption

fn options(&self) -> ToolOptions

Get the tool’s configuration options