Struct AskUserTool 

pub struct AskUserTool { /* private fields */ }

The structured user-question tool. name is the registered spelling — ASK_USER under cc-parity, additionally REQUEST_USER_INPUT under cx-parity.

Implementations

impl AskUserTool

pub fn new(name: &'static str) -> Self

A tool registered under name (one of ASK_USER / REQUEST_USER_INPUT).

Trait Implementations

impl Clone for AskUserTool

fn clone(&self) -> AskUserTool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AskUserTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AskUserTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for AskUserTool

fn name(&self) -> &str

Stable, unique tool name (what the model calls).

fn description(&self) -> &str

The built-in description. May be overridden via crate::Config.

fn parameters(&self) -> Value

JSON Schema describing the tool’s input object.

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

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

Run the tool. Returns text to feed back to the model.

fn structured_output(&self) -> bool

Whether a successful textual result is also a complete JSON value that protocol adapters should expose as structured output. Text remains the model-facing representation, preserving compatibility.