Struct RegisteredTool 

pub struct RegisteredTool {
    pub tool: Arc<dyn Tool>,
    pub snippet: Option<String>,
    pub guidelines: Vec<String>,
    pub exposure: Exposure,
    pub namespace: Option<Namespace>,
    pub default_active: bool,
    pub annotations: Option<Value>,
    pub source: Option<SourceInfo>,
}

A tool as registered with a session: the tool, the text it adds to the system prompt, and how it reaches the model.

Fields

tool: Arc<dyn Tool>

The tool.

snippet: Option<String>

One-line summary for the prompt’s tool list, which leaves out tools without one.

guidelines: Vec<String>

Bullets added to the prompt’s rules.

exposure: Exposure

How it reaches the model.

namespace: Option<Namespace>

Its group.

default_active: bool

Whether registering it activates it, when its exposure is declarable.

annotations: Option<Value>

pi’s ToolAnnotations, such as readOnlyHint.

source: Option<SourceInfo>

The extension that registered it, or None for a built-in tool.

Implementations

impl RegisteredTool

pub fn direct( tool: Arc<dyn Tool>, snippet: Option<String>, guidelines: Vec<String>, ) -> Self

A direct built-in tool, active on registration.

pub fn name(&self) -> &str

The tool’s name.

pub fn info(&self) -> ToolInfo

The tool as extensions see it.

Trait Implementations

impl Clone for RegisteredTool

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.