Struct TextBrowserTool 

pub struct TextBrowserTool { /* private fields */ }

Text browser tool: renders web pages as plain text using text-based browsers (lynx, links, w3m). Ideal for headless/SSH environments where graphical browsers are unavailable.

The selected external browser owns its transport, resolves DNS again, and follows redirects without ZeroClaw revalidating each destination. Unlike web_fetch, this tool cannot pin the preflight answer. The resolved-address checks are defense in depth, not a DNS-rebinding or redirect boundary. Prefer web_fetch for attacker-controlled URLs.

Implementations

impl TextBrowserTool

pub fn new( security: Arc<SecurityPolicy>, preferred_browser: Option<String>, timeout_secs: u64, nat64_prefixes: Vec<String>, ) -> Result<TextBrowserTool, Error>

Construct with no private-host opt-in (deny-by-default). Use Self::new_with_private_hosts to allow specific private hosts.

pub fn new_with_private_hosts( security: Arc<SecurityPolicy>, preferred_browser: Option<String>, timeout_secs: u64, allowed_private_hosts: Vec<String>, nat64_prefixes: Vec<String>, ) -> Result<TextBrowserTool, Error>

Construct with an explicit allowed_private_hosts opt-in list (mirrors the browser/browser_open/http_request pattern from PRsand

Trait Implementations

impl Attributable for TextBrowserTool

fn role(&self) -> Role

fn alias(&self) -> &str

fn tool_provenance(&self) -> ToolProvenance

Classifies whether a tool implementation is first-party native code or an extension. The conservative default prevents a new wrapper from inheriting native presentation privileges accidentally.

impl Tool for TextBrowserTool

fn name(&self) -> &str

Tool name (used in LLM function calling)

fn description(&self) -> &str

Human-readable description

fn parameters_schema(&self) -> Value

JSON schema for parameters

fn execute<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = Result<ToolResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, TextBrowserTool: 'async_trait,

Execute the tool with given arguments

fn output_schema(&self) -> Option<Value>

JSON schema describing the structured output this tool attaches to ToolOutput::data, when it declares one. None means the tool emits display text only; authoring surfaces fall back to sample-derived shapes from captured runs.

fn param_domains(&self) -> Vec<(&'static str, OptionDomain)>

Option domains for parameters whose value sets live in runtime config rather than the static schema (channel refs, peer targets, …). Surfaces resolve these through the runtime to render real selectable choices. Default: no domain-typed parameters.

fn invocation_triggers(&self) -> Vec<String>

Lowercase phrases that suggest an inbound message wants this tool — e.g. routing wording or configured destination names for a delivery tool. A pre-turn prefilter may scan the message against these and nudge the model to consider the tool; the tool itself is never called by the prefilter.

fn spec(&self) -> ToolSpec

Assemble this tool’s spec. The default recomposes it from parameters_schema() and allocates a fresh Arc per call, so tools with large stored schemas override it to hand out Arc::clone instead (see McpToolWrapper). Delegating wrappers around a dyn Tool MUST forward spec() to the inner tool — relying on this default silently reintroduces a per-iteration deep clone of the inner schema and breaks Arc identity for downstream sharing.