Skip to main content

ToolDef

Struct ToolDef 

Source
pub struct ToolDef {
    pub name: String,
    pub description: String,
    pub input_schema: Value,
    pub tags: Vec<String>,
    pub category: Option<String>,
}
Expand description

OpenAPI-style tool definition: name, description, input schema.

Describes a sub-tool registered with a ScriptedToolBuilder or usable standalone. The input_schema is optional JSON Schema for documentation / LLM prompts and for type coercion of --key value flags.

Fields§

§name: String

Command name used as bash builtin (e.g. "get_user").

§description: String

Human-readable description for LLM consumption.

§input_schema: Value

JSON Schema describing accepted arguments. Empty object if unspecified.

§tags: Vec<String>

Categorical tags for discovery (e.g. ["admin", "billing"]).

§category: Option<String>

Grouping category for discovery (e.g. "payments").

Implementations§

Source§

impl ToolDef

Source

pub fn new(name: impl Into<String>, description: impl Into<String>) -> Self

Create a tool definition with name and description.

Source

pub fn with_schema(self, schema: Value) -> Self

Attach a JSON Schema for the tool’s input parameters.

Source

pub fn with_tags(self, tags: &[&str]) -> Self

Add categorical tags for discovery filtering.

Source

pub fn with_category(self, category: &str) -> Self

Set the grouping category for discovery.

Trait Implementations§

Source§

impl Clone for ToolDef

Source§

fn clone(&self) -> Self

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

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