Skip to main content

ToolInput

Struct ToolInput 

Source
pub struct ToolInput {
    pub data: Value,
    pub tool_name: String,
    pub agent_id: String,
    pub user_id: Option<String>,
}
Expand description

Input parameters received by a tool handler.

Wraps the JSON input from the agent with convenience accessors.

Fields§

§data: Value

Raw JSON input from the agent.

§tool_name: String

The tool name being invoked.

§agent_id: String

The agent ID making the request.

§user_id: Option<String>

The user ID making the request, if known. None for system- initiated work that didn’t opt into a synthetic identity. Skills that read per-user credentials via vault::get don’t need this — the host applies user scoping automatically — but it’s exposed here for skills that want to surface “I am acting on behalf of X” in their tool output.

Implementations§

Source§

impl ToolInput

Source

pub fn from_json(json: &str) -> Option<Self>

Parse a ToolInput from the request JSON the runtime provides.

Source

pub fn get_str(&self, key: &str) -> Option<&str>

Get a string parameter by key.

Source

pub fn get_i64(&self, key: &str) -> Option<i64>

Get an integer parameter by key.

Source

pub fn get_f64(&self, key: &str) -> Option<f64>

Get a float parameter by key.

Source

pub fn get_bool(&self, key: &str) -> Option<bool>

Get a boolean parameter by key.

Source

pub fn get(&self, key: &str) -> Option<&Value>

Get a nested JSON value by key.

Source

pub fn raw(&self) -> &Value

Get the raw input as a reference.

Trait Implementations§

Source§

impl Clone for ToolInput

Source§

fn clone(&self) -> ToolInput

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 ToolInput

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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