Struct SubAgent 

pub struct SubAgent { /* private fields */ }

A tool that wraps an agent, enabling multi-agent composition.

When executed, constructs a fresh Agent via the options_factory, sends the prompt extracted from tool call params, and maps the AgentResult into an AgentToolResult.

Implementations

impl SubAgent

pub fn new( name: impl Into<String>, label: impl Into<String>, description: impl Into<String>, ) -> Self

Start building a sub-agent tool with the given identity.

Defaults to a schema that accepts a prompt string parameter. Use with_options to configure the inner agent.

pub fn simple( name: impl Into<String>, label: impl Into<String>, description: impl Into<String>, system_prompt: impl Into<String>, model: ModelSpec, stream_fn: Arc<dyn StreamFn>, ) -> Self

Convenience constructor that builds a fully configured sub-agent.

Creates an AgentOptions::new_simple() internally with the provided system prompt, model, and stream function.

pub fn with_schema(self, schema: Value) -> Self

Set a custom JSON Schema for the tool parameters.

pub const fn with_requires_approval(self, requires: bool) -> Self

Set whether this tool requires approval before execution.

pub fn with_options( self, f: impl Fn() -> AgentOptions + Send + Sync + 'static, ) -> Self

Set the factory closure that creates agent options for each execution.

pub fn with_map_result( self, f: impl Fn(AgentResult) -> AgentToolResult + Send + Sync + 'static, ) -> Self

Set a custom result mapper from AgentResult to AgentToolResult.

Trait Implementations

impl AgentTool for SubAgent

fn name(&self) -> &str

Unique routing key used to dispatch tool calls.

fn label(&self) -> &str

Human-readable display name for logging and UI.

fn description(&self) -> &str

Natural-language description included in the LLM prompt.

fn parameters_schema(&self) -> &Value

JSON Schema describing the tool’s input shape, used for validation.

fn requires_approval(&self) -> bool

Whether this tool requires user approval before execution. Default is false — tools execute immediately.

fn execute( &self, _tool_call_id: &str, params: Value, cancellation_token: CancellationToken, _on_update: Option<Box<dyn Fn(AgentToolResult) + Send + Sync>>, _state: Arc<RwLock<SessionState>>, _credential: Option<ResolvedCredential>, ) -> ToolFuture<'_>

Execute the tool with validated parameters.

fn metadata(&self) -> Option<ToolMetadata>

Optional organizational metadata (namespace, version).

fn approval_context(&self, _params: &Value) -> Option<Value>

Optional rich context for the approval UI.

fn auth_config(&self) -> Option<AuthConfig>

Optional authentication configuration for this tool.

impl Debug for SubAgent

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

Formats the value using the given formatter.