Skip to main content

ToolPolicy

Struct ToolPolicy 

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

Tool permission policy: permission tiering + sandbox gate.

When no policy is configured the executor does not enforce anything; once configured, every tool execution is checked via ToolPolicy::check before it runs.

§Example

use lc_agents::{AgentExecutor, ToolPolicy, ToolRisk};

let policy = ToolPolicy::new()
    .risk("code_interpreter", ToolRisk::Dangerous)
    .sandboxed("code_interpreter"); // wrapped in a restricted env, allowed to run
let executor = AgentExecutor::new(agent, tools).with_tool_policy(policy);

Implementations§

Source§

impl ToolPolicy

Source

pub fn new() -> Self

Empty policy: every tool defaults to ToolRisk::Safe, the permitted tier is the highest, and there is no sandbox allowlist.

Source

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

Declare a tool’s risk level.

Source

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

Declare that a tool is wrapped in a restricted environment (sandbox-gate allowlist).

Source

pub fn with_default_risk(self, risk: ToolRisk) -> Self

Set the default risk level for tools not explicitly declared.

Source

pub fn with_max_permitted(self, risk: ToolRisk) -> Self

Set the highest risk tier the executor permits (permission tiering).

Source

pub fn allow_unrestricted_dangerous(self, allow: bool) -> Self

Explicitly allow unsandboxed dangerous tools (an escape hatch for tools that are dangerous but must run bare; off by default).

Source

pub fn risk_of(&self, name: &str) -> ToolRisk

Resolve a tool’s risk level.

Source

pub fn check(&self, name: &str) -> Result<(), AgentError>

Pre-execution gate: returns AgentError when the tool does not meet the policy, Ok(()) when it passes.

Trait Implementations§

Source§

impl Clone for ToolPolicy

Source§

fn clone(&self) -> ToolPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ToolPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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