Skip to main content

AgentBuilder

Struct AgentBuilder 

Source
pub struct AgentBuilder { /* private fields */ }

Implementations§

Source§

impl AgentBuilder

Source

pub fn new(client: Arc<dyn LlmProvider>) -> AgentBuilder

Source

pub fn with_multi_agent(self, config: MultiAgentConfig) -> AgentBuilder

Enable multi-agent support with the given configuration.

Also sets the tool factory to create the 5 multi-agent tools. Callers should use phi_kernel_tools::multi_agent::create_all_tools as the factory.

Source

pub fn without_multi_agent(self) -> AgentBuilder

Disable multi-agent support.

Removes any previously set multi-agent configuration. No multi-agent tools will be registered and the system prompt will not mention multi-agent capabilities.

Source

pub fn with_multi_agent_tool_factory( self, factory: Arc<dyn Fn(Arc<MultiAgentRuntime>) -> Vec<Arc<dyn Tool>> + Send + Sync>, ) -> AgentBuilder

Set a custom factory for creating multi-agent tools.

The factory receives the MultiAgentRuntime and returns the tools to register. If not set but multi-agent is enabled, no tools are registered (caller must set this for multi-agent to work).

Source

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

Source

pub fn enable_thought(self, enable: bool) -> AgentBuilder

Source

pub fn reasoning(self, config: ReasoningConfig) -> AgentBuilder

Source

pub fn enable_thinking(self, enable: bool) -> AgentBuilder

Source

pub fn thinking_budget(self, budget: u64) -> AgentBuilder

Source

pub fn tool_timeout(self, timeout_ms: u64) -> AgentBuilder

Source

pub fn max_tool_output_chars(self, max_chars: usize) -> AgentBuilder

Source

pub fn max_sessions(self, max: usize) -> AgentBuilder

Source

pub fn max_turns_per_session(self, max: usize) -> AgentBuilder

Source

pub fn execution_max_turns(self, max: u32) -> AgentBuilder

Source

pub fn max_message_tokens(self, max: usize) -> AgentBuilder

Source

pub fn register_tool(self, tool: impl Tool + 'static) -> AgentBuilder

Source

pub fn register_tool_arc(self, tool: Arc<dyn Tool>) -> AgentBuilder

Source

pub fn approval_handler(self, handler: Arc<dyn ApprovalHandler>) -> AgentBuilder

Source

pub fn tool_policy(self, policy: Arc<dyn ToolPolicy>) -> AgentBuilder

Source

pub fn middleware(self, mw: impl Middleware + 'static) -> AgentBuilder

Source

pub fn guard(self, guard: impl ReactLoopGuard + 'static) -> AgentBuilder

Source

pub fn context_window(self, max_tokens: usize) -> AgentBuilder

Source

pub fn context_window_manager( self, manager: ContextWindowManager, ) -> AgentBuilder

Source

pub fn response_format(self, format: ResponseFormat) -> AgentBuilder

Source

pub fn llm_retry(self, retry: RetryConfig) -> AgentBuilder

Source

pub fn session_store(self, store: Arc<dyn SessionStore>) -> AgentBuilder

Source

pub fn error_recovery( self, recovery: Arc<dyn ToolErrorRecovery>, ) -> AgentBuilder

Source

pub fn tool_error_retry_prompt(self, prompt: impl Into<String>) -> AgentBuilder

Source

pub fn language(self, language: Language) -> AgentBuilder

Source

pub fn context_compactor( self, compactor: Arc<dyn ContextCompaction>, ) -> AgentBuilder

Set an inline context compactor for the react loop.

When set, the react loop will check token count after each tool turn and compact the session if it exceeds the configured threshold.

Source

pub fn event_bus_capacity(self, capacity: usize) -> AgentBuilder

Source

pub fn session_id_generator( self, generator: Arc<dyn SessionIdGenerator>, ) -> AgentBuilder

Source

pub fn apply_if<T>( self, value: Option<T>, f: impl FnOnce(AgentBuilder, T) -> AgentBuilder, ) -> AgentBuilder

Conditionally apply a transformation when value is Some.

This is a convenience for option-chaining builder patterns:

ⓘ
builder.apply_if(args.thinking_budget, |b, budget| b.thinking_budget(budget))
Source

pub fn agent_instructions_paths(self, paths: Vec<PathBuf>) -> AgentBuilder

Set paths to agent instruction files (e.g., CLAUDE.md, INSTRUCTIONS.md).

These files are read at build time and appended to the system prompt. Supports multiple paths (user-level + project-level); later entries have higher priority and appear first in the prompt.

Example:

ⓘ
use std::path::PathBuf;
use agent_works::AgentBuilder;
let builder = AgentBuilder::new();
let builder = builder.agent_instructions_paths(vec![
    PathBuf::from("~/.claude/CLAUDE.md"),  // user-level
    PathBuf::from(".claude/CLAUDE.md"),     // project-level
]);
Source

pub fn build(self) -> Result<AgentRuntime, AgentError>

Source

pub fn build_with_ma( self, ) -> Result<(AgentRuntime, Option<Arc<MultiAgentRuntime>>), AgentError>

Build the runtime and return the multi-agent runtime (if enabled).

Same as build but also returns the MultiAgentRuntime created during setup. Callers that need to start the watcher task or access the mailbox should use this method.

Auto Trait Implementations§

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> 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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