Skip to main content

AgentBuilder

Struct AgentBuilder 

Source
pub struct AgentBuilder<P: Provider> { /* private fields */ }
Expand description

Builder for creating agents

Implementations§

Source§

impl<P: Provider> AgentBuilder<P>

Source

pub fn new(provider: P) -> Self

Create a new builder with a provider

Source

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

Set the model to use

Source

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

Set the system prompt

Source

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

Alias for system_prompt

Source

pub fn temperature(self, temp: f64) -> Self

Set the temperature

Source

pub fn max_tokens(self, tokens: u64) -> Self

Set max tokens

Source

pub fn extra_params(self, params: Value) -> Self

Add extra provider-specific parameters

Source

pub fn tool_policy(self, policy: RiskyToolPolicy) -> Self

Set tool policy

Source

pub fn approval_handler(self, handler: impl ApprovalHandler + 'static) -> Self

Set external approval handler

Source

pub fn interaction_handler( self, handler: impl InteractionHandler + 'static, ) -> Self

Set interaction handler (for HITL)

Source

pub fn max_history_messages(self, count: usize) -> Self

Set max history messages (sliding window)

Source

pub fn max_tool_output_chars(self, count: usize) -> Self

Set max tool output characters

Source

pub fn json_mode(self, enable: bool) -> Self

Enable strict JSON mode (enforces response_format: json_object)

Source

pub fn persona(self, persona: Persona) -> Self

Set the agent’s personality

Source

pub fn notifier(self, notifier: impl Notifier + 'static) -> Self

Set a notifier

Source

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

Set session ID for persistence

Source

pub fn role(self, role: AgentRole) -> Self

Set the agent’s role

Source

pub fn context_injector(self, injector: impl ContextInjector + 'static) -> Self

Add a context injector

Source

pub fn tool<T: Tool + 'static>(self, tool: T) -> Self

Add a tool

Source

pub fn shared_tool(self, tool: Arc<dyn Tool>) -> Self

Add a shared tool

Source

pub fn tools(self, tools: ToolSet) -> Self

Add multiple tools from a toolset

Source

pub fn with_memory(self, memory: Arc<dyn Memory>) -> Self

Add memory tools using the provided memory implementation

Source

pub fn with_dynamic_skills(self, skill_loader: Arc<SkillLoader>) -> Result<Self>

Add DynamicSkill support (ClawHub skills, custom scripts)

§Security

CRITICAL: DynamicSkill and Python Sidecar are mutually exclusive. This method will return an error if Python Sidecar has already been configured.

Rationale: If both are enabled, malicious DynamicSkills can pollute the Agent’s context with secrets, which may then be used by LLM-generated Python code in the unsandboxed Sidecar to exfiltrate data.

See SECURITY.md for details.

Source

pub async fn with_code_interpreter( self, address: impl Into<String>, ) -> Result<Self>

Add code interpreter capability using the given sidecar address

§Security

CRITICAL: Python Sidecar and DynamicSkill are mutually exclusive. This method will return an error if DynamicSkill has already been configured.

Rationale: Python Sidecar has no sandbox isolation. If DynamicSkill is also enabled, malicious skills can pollute the Agent’s context, leading to secret exfiltration via LLM-generated Python code in the Sidecar.

See SECURITY.md for details.

Source

pub fn build(self) -> Result<Agent<P>>

Build the agent

§Security Defaults

If neither Python Sidecar nor DynamicSkill has been explicitly configured, this method will automatically enable DynamicSkill with default settings:

  • Skills directory: ./skills
  • Network access: disabled (secure sandbox)

To use Python Sidecar instead, call .with_code_interpreter() before .build().

Source

pub fn with_delegation(self, coordinator: Arc<Coordinator>) -> Self

Add delegation support using the provided coordinator

Source

pub fn with_scheduler(self, scheduler: Arc<Scheduler>) -> Self

Add scheduling support using the provided scheduler

Source

pub fn with_swarm( self, manager: Arc<Mutex<SwarmManager>>, cmd_rx: Receiver<SwarmEvent>, ) -> Self

Enable dynamic swarming capabilities

Auto Trait Implementations§

§

impl<P> Freeze for AgentBuilder<P>
where P: Freeze,

§

impl<P> !RefUnwindSafe for AgentBuilder<P>

§

impl<P> Send for AgentBuilder<P>

§

impl<P> Sync for AgentBuilder<P>

§

impl<P> Unpin for AgentBuilder<P>
where P: Unpin,

§

impl<P> !UnwindSafe for AgentBuilder<P>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> GetSetFdFlags for T

Source§

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.
Source§

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more
Source§

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Pointer = u32

Source§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more