pub struct ToolServerHandle(/* private fields */);Expand description
The shareable, runtime-mutable tool registry.
Implementations§
Source§impl ToolServerHandle
impl ToolServerHandle
Sourcepub fn attach(&self, bus: &Registrar)
pub fn attach(&self, bus: &Registrar)
Publish every registration onto bus, now and as they change.
Sourcepub fn add_dynamic_tool(&self, tool: DynamicTool)
pub fn add_dynamic_tool(&self, tool: DynamicTool)
Add a runtime-defined tool.
Sourcepub fn add_registered_tool(&self, tool: RegisteredTool)
pub fn add_registered_tool(&self, tool: RegisteredTool)
Add a registration built elsewhere.
Sourcepub fn remove_tool(&self, tool_name: &str)
pub fn remove_tool(&self, tool_name: &str)
Remove the tool named tool_name.
Sourcepub async fn execute(
&self,
tool_name: &str,
args: &str,
context: &mut ToolContext,
) -> ToolResult
pub async fn execute( &self, tool_name: &str, args: &str, context: &mut ToolContext, ) -> ToolResult
Run tool_name inline, publishing its result metadata into
context.
Sourcepub fn snapshot(&self) -> ToolCatalog
pub fn snapshot(&self) -> ToolCatalog
The always-exposed registrations, pinned.
Sourcepub fn static_tool_defs(&self) -> Vec<ToolDefinition>
pub fn static_tool_defs(&self) -> Vec<ToolDefinition>
The always-exposed definitions.
Sourcepub async fn tool_defs(
&self,
prompt: Option<String>,
) -> Result<Vec<ToolDefinition>, ToolServerError>
pub async fn tool_defs( &self, prompt: Option<String>, ) -> Result<Vec<ToolDefinition>, ToolServerError>
Retrieve advertised definitions for prompt, returning retrieval failures
or incompatible result shapes as definition errors.
Sourcepub fn retrieval_keys(&self) -> Vec<HandlerKey>
pub fn retrieval_keys(&self) -> Vec<HandlerKey>
Return registered retrieval index keys in registration order.
Sourcepub fn retrieval_effects(
&self,
prompt: Option<String>,
) -> Vec<(HandlerKey, EffectKind)>
pub fn retrieval_effects( &self, prompt: Option<String>, ) -> Vec<(HandlerKey, EffectKind)>
Build one TopNIds effect per retrieval index for the supplied prompt.
Returns no effects without a prompt; pass returned IDs to
Self::snapshot_with_dynamic after dispatch.
Sourcepub fn snapshot_with_dynamic(&self, dynamic_tool_ids: &[String]) -> ToolCatalog
pub fn snapshot_with_dynamic(&self, dynamic_tool_ids: &[String]) -> ToolCatalog
Pin retrieved tools in ID order, then always-exposed tools in registration order. Deduplicates names and skips missing registrations.
Trait Implementations§
Source§impl Clone for ToolServerHandle
impl Clone for ToolServerHandle
Source§impl ManagedToolSink for ToolServerHandle
impl ManagedToolSink for ToolServerHandle
Source§fn add_managed_tools(
&self,
tools: Vec<DynamicTool>,
) -> HashMap<String, ManagedToolToken>
fn add_managed_tools( &self, tools: Vec<DynamicTool>, ) -> HashMap<String, ManagedToolToken>
!is_live() are skipped. Returns one generation token per
installed name, to hand back to Self::reconcile_managed_tools.Source§fn reconcile_managed_tools(
&self,
expected: HashMap<String, ManagedToolToken>,
tools: Vec<DynamicTool>,
) -> HashMap<String, ManagedToolToken>
fn reconcile_managed_tools( &self, expected: HashMap<String, ManagedToolToken>, tools: Vec<DynamicTool>, ) -> HashMap<String, ManagedToolToken>
expected generation is
still current (newer local or peer-source registrations win); names
missing from tools and still owned by this source are removed.
Returns the new generation tokens.