Struct GitHubSearchTool 

pub struct GitHubSearchTool { /* private fields */ }

GitHub repository search tool using the GitHub REST API.

Implementations

impl GitHubSearchTool

pub fn new(cache: Arc<SearchCache>) -> Self

Create a new GitHubSearchTool with the given search cache.

Trait Implementations

impl AgentTool for GitHubSearchTool

fn name(&self) -> &str

Tool name (used in function calls)

fn label(&self) -> &str

Human-readable label

fn description(&self) -> &str

Description for the model

fn parameters_schema(&self) -> Value

JSON Schema for parameters

fn execute<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _tool_call_id: &'life1 str, params: Value, _signal: Option<Receiver<()>>, _ctx: &'life2 ToolContext, ) -> Pin<Box<dyn Future<Output = Result<AgentToolResult, ToolError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute the tool with the given tool call ID and parameters.

fn essential(&self) -> bool

Whether this tool is essential (cannot be disabled). Essential tools: read, write, edit, bash, grep, find, ls Optional tools: web_search, github, subagent, etc.

fn on_progress(&self, _callback: ProgressCallback)

Called with progress updates during execution. Tools can override this to emit streaming updates.

fn to_definition(&self) -> ToolDefinition

Convert to ToolDefinition