Struct AsToolOptions 

pub struct AsToolOptions {
    pub name: Option<String>,
    pub description: Option<String>,
    pub arg_name: Option<String>,
    pub arg_description: Option<String>,
    pub approval_mode: ApprovalMode,
    pub stream_callback: Option<AgentToolStreamCallback>,
    pub propagate_session: bool,
}

Options for Agent::as_tool.

Fields

name: Option<String>

The tool name. Defaults to the agent’s name (else its id).

description: Option<String>

The tool description. Defaults to the agent’s description (else empty).

arg_name: Option<String>

The single string argument’s name. Defaults to "task".

arg_description: Option<String>

The argument’s description. Defaults to "Task for {tool_name}".

approval_mode: ApprovalMode

Whether calls to this delegated tool require human approval before executing (default: no). Mirrors upstream as_tool(approval_mode=…).

stream_callback: Option<AgentToolStreamCallback>

Observe the sub-agent’s streamed updates as they arrive. When set, the wrapper runs the sub-agent via run_stream and invokes the callback on every update before aggregating the final response. Mirrors upstream as_tool(stream_callback=…).

propagate_session: bool

Forward the parent agent’s session to the sub-agent, so both share the same session identity and state bag.

The sub-agent receives a AgentSession::child of the parent’s session: same session_id, shared state, but an isolated service_session_id — the parent’s server-side conversation pointer (whose tool call is still pending mid-run) must not leak into the sub-agent’s own service calls. Mirrors upstream as_tool(propagate_session=True) with the child-session isolation fix (microsoft/agent-framework#5875). Defaults to false (a fresh session per call).

Implementations

impl AsToolOptions

pub fn new() -> Self

pub fn name(self, name: impl Into<String>) -> Self

Set the tool name.

pub fn description(self, description: impl Into<String>) -> Self

Set the tool description.

pub fn arg_name(self, arg_name: impl Into<String>) -> Self

Set the argument name (default "task").

pub fn arg_description(self, arg_description: impl Into<String>) -> Self

Set the argument description.

pub fn approval_mode(self, mode: ApprovalMode) -> Self

Require human approval before every call to the delegated tool.

pub fn stream_callback(self, callback: AgentToolStreamCallback) -> Self

Observe the sub-agent’s streamed updates (see AsToolOptions::stream_callback).

pub fn propagate_session(self, propagate: bool) -> Self

Forward the parent agent’s session to the sub-agent (see AsToolOptions::propagate_session).

Trait Implementations

impl Clone for AsToolOptions

fn clone(&self) -> AsToolOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AsToolOptions

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

Formats the value using the given formatter.

impl Default for AsToolOptions

fn default() -> AsToolOptions

Returns the “default value” for a type.