Struct WebFetchTool 

pub struct WebFetchTool { /* private fields */ }

Tool that fetches content from a URL using fetchkit

THREAT[TM-API-008]: SSRF protection via fetchkit DnsPolicy Mitigation: Default FetchOptions uses DnsPolicy::block_private_ips(), which blocks loopback, RFC1918, link-local (cloud metadata), and other reserved IP ranges via resolve-then-check with DNS pinning.

File download: when save_to_file is provided, content is saved through the session filesystem (SessionFileSystem) via the SessionFileSaver adapter.

Implementations

impl WebFetchTool

pub fn new(enable_save_to_file: bool, bot_auth: Option<BotAuthConfig>) -> Self

Create a new WebFetchTool with file download and optional bot-auth signing.

Trait Implementations

impl Default for WebFetchTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for WebFetchTool

fn narrate( &self, tool_call: &ToolCall, phase: ToolNarrationPhase, locale: Option<&str>, _ctx: ToolNarrationContext<'_>, ) -> Option<String>

Returns backend-authored narration for a call to this tool, e.g. “Read AGENTS.md”.

fn name(&self) -> &str

Returns the tool’s unique name.

fn display_name(&self) -> Option<&str>

Returns a human-readable display name for UI rendering.

fn description(&self) -> &str

Returns a description of what the tool does.

fn parameters_schema(&self) -> Value

Returns the JSON schema for the tool’s parameters.

fn requires_context(&self) -> bool

Returns true if this tool requires context for execution.

fn hints(&self) -> ToolHints

Returns semantic hints describing the tool’s behavioral properties.

fn execute<'life0, 'async_trait>( &'life0 self, arguments: Value, ) -> Pin<Box<dyn Future<Output = ToolExecutionResult> + Send + 'async_trait>>

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

Execute the tool with the given arguments.

fn execute_with_context<'life0, 'life1, 'async_trait>( &'life0 self, arguments: Value, context: &'life1 ToolContext, ) -> Pin<Box<dyn Future<Output = ToolExecutionResult> + Send + 'async_trait>>

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

Execute the tool with context.

fn policy(&self) -> ToolPolicy

Returns the tool policy (auto or requires_approval).

fn as_background_executable(&self) -> Option<&dyn BackgroundExecutableTool>

Returns native background execution support when this tool opts into detached execution via hints().supports_background.

fn deferrable_policy(&self) -> DeferrablePolicy

Deferral policy for progressive tool-schema disclosure (tool search). Hot-path or “consult-first” tools can return DeferrablePolicy::Never to always keep their full schema directly callable. Defaults to DeferrablePolicy::Automatic.

fn to_definition(&self) -> ToolDefinition

Convert this tool to a ToolDefinition for the agent config.