Skip to main content

BuiltinTools

Struct BuiltinTools 

Source
pub struct BuiltinTools { /* private fields */ }
Expand description

Built-in tools: read_file, write_file, edit_file, list_dir, shell.

Carries the PlatformCapabilities of the current platform; tools whose tool_required_capabilities aren’t satisfied are dropped from tool_defs, names, and rejected by execute.

Implementations§

Source§

impl BuiltinTools

Source

pub fn tool_defs(&self) -> Vec<Tool>

All tool definitions to advertise to the LLM, minus any whose required platform capabilities aren’t provided by the current platform.

Source

pub fn subagent_tool_defs() -> Vec<Tool>

Tool definitions for sub-agent management tools.

These are advertised to the LLM but executed externally (by the CLI’s tool registry) since they require access to the AgentEngine.

Source

pub fn subagent_tool_names() -> Vec<String>

Names of sub-agent tools.

Source

pub fn names(&self) -> Vec<String>

Names of all built-in tools, including every alias in TOOL_ALIASES.

Aliases are included so tool-call dispatch recognizes a call arriving under an alias name as a built-in; the canonical names are what get advertised to the model.

Source§

impl BuiltinTools

Source

pub async fn execute(&self, name: &str, args: Value) -> String

Execute a built-in tool by name (resolving aliases), returning the result as a string.

Source§

impl BuiltinTools

Source

pub fn new(ctx: ToolContext) -> Self

Create a new BuiltinTools instance with the given sandbox context, filtering tools against the current platform’s capabilities.

Source

pub fn with_shell_executor(self, executor: Arc<dyn ShellExecutor>) -> Self

Route this agent’s shell execution through executor (a container / namespace sandbox) instead of the host.

Source

pub fn with_capabilities( ctx: ToolContext, platform: PlatformCapabilities, ) -> Self

Create a BuiltinTools instance with an explicit platform capability set, for tests or hosts that need to override the compile-time default.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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