Skip to main content

ToolSpec

Struct ToolSpec 

Source
pub struct ToolSpec {
    pub name: &'static str,
    pub description: &'static str,
    pub input_schema: fn() -> Value,
    pub data_schema: DataSchema,
    pub mutates: bool,
    pub facet: Facet,
    pub handler: fn(&Ctx, &Value) -> Result<ToolOutcome, EngineFault>,
}
Expand description

One tool, shared verbatim by the CLI and the MCP server (design §2.2).

Fields§

§name: &'static str

Wire name, e.g. "render". Also the CLI subcommand stem.

§description: &'static str

Human/agent-facing description. This is ALSO the embedded agent prompt — it carries behavioral guidance, not just a label — and is rendered into MCP tools/list and scrybe <cmd> --help verbatim.

§input_schema: fn() -> Value

JSON Schema for arguments (MCP inputSchema; also drives CLI arg parse).

§data_schema: DataSchema

Versioned, typed schema for the tool’s stable data payload.

§mutates: bool

Does this tool change editor/disk/app state? Gates read-only agents and dry-run mode.

§facet: Facet

Tool group for progressive disclosure + feature gating.

§handler: fn(&Ctx, &Value) -> Result<ToolOutcome, EngineFault>

The one implementation, shared by both front ends. Ok(outcome) even for business failures (a tool_error inside the outcome); Err is reserved for EngineFaults — e.g. the transport failing mid-request.

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.