Struct DiscoverTool 

pub struct DiscoverTool { /* private fields */ }

A Tool that exposes only discover and help builtins for runtime schema discovery. Returned by ScriptingToolSet::tools in DiscoveryMode::WithDiscovery mode alongside the main script tool.

The LLM uses this tool to explore available commands before writing scripts for the main tool.

use bashkit::Tool;
use bashkit_scripted_tool::{ScriptingToolSet, ToolArgs, ToolDef};

let toolset = ScriptingToolSet::builder("api")
    .tool_fn(
        ToolDef::new("greet", "Greet someone").with_category("social"),
        |_args: &ToolArgs| Ok("hello\n".to_string()),
    )
    .with_discovery()
    .build();

let tools = toolset.tools();
assert_eq!(tools.len(), 2);

// Second tool is the DiscoverTool
let discover = &tools[1];
assert!(discover.name().ends_with("_discover"));

Trait Implementations

impl Tool for DiscoverTool

fn name(&self) -> &str

Tool identifier (e.g., “bashkit”, “calculator”)

fn display_name(&self) -> &str

Human-readable display name for UI.

fn short_description(&self) -> &str

One-line description for tool listings

fn description(&self) -> &str

Token-efficient description for LLMs.

fn help(&self) -> String

Full documentation for LLMs (markdown, with examples)

fn system_prompt(&self) -> String

Condensed description for system prompts (token-efficient)

fn locale(&self) -> &str

Locale used for user-facing text.

fn input_schema(&self) -> Value

JSON Schema for input validation

fn output_schema(&self) -> Value

JSON Schema for output structure

fn version(&self) -> &str

Library/tool version

fn execution(&self, args: Value) -> Result<ToolExecution, ToolError>

Create a single-use execution.

fn execute<'life0, 'async_trait>( &'life0 self, req: ToolRequest, ) -> Pin<Box<dyn Future<Output = ToolResponse> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the tool

fn execute_with_status<'life0, 'async_trait>( &'life0 self, req: ToolRequest, status_callback: Box<dyn FnMut(ToolStatus) + Send>, ) -> Pin<Box<dyn Future<Output = ToolResponse> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute with status callbacks for progress tracking