Files
clawdbot/docs/tools/web.md
2026-01-15 04:25:19 +00:00

2.4 KiB
Raw Blame History

summary, read_when
summary read_when
Web search + fetch tools (Brave Search API)
You want to enable web_search or web_fetch
You need Brave Search API key setup

Web tools

Clawdbot ships two lightweight web tools:

  • web_search — Brave Search API queries (fast, structured results).
  • web_fetch — HTTP fetch + readable extraction (HTML → markdown/text).

These are not browser automation. For JS-heavy sites or logins, use the Browser tool.

How it works

  • web_search calls Braves Search API and returns structured results (title, URL, snippet). No browser is involved.
  • Results are cached by query for 15 minutes (configurable).
  • web_fetch does a plain HTTP GET and extracts readable content (HTML → markdown/text). It does not execute JavaScript.
  • In sandboxed sessions, web_fetch is enabled automatically (unless explicitly disabled).

Getting a Brave API key

  1. Create a Brave Search API account at https://brave.com/search/api/
  2. Generate an API key in the dashboard.
  3. Set BRAVE_API_KEY in your environment or paste it into tools.web.search.apiKey.

Brave provides a free tier plus paid plans; check the Brave API portal for the current limits and pricing.

Search the web with Braves API.

Requirements

  • tools.web.search.enabled: true
  • Brave API key via BRAVE_API_KEY or tools.web.search.apiKey

Config

{
  tools: {
    web: {
      search: {
        enabled: true,
        apiKey: "BRAVE_API_KEY_HERE", // optional if BRAVE_API_KEY is set
        maxResults: 5,
        timeoutSeconds: 30,
        cacheTtlMinutes: 15
      }
    }
  }
}

Tool parameters

  • query (required)
  • count (110; default from config)

web_fetch

Fetch a URL and extract readable content.

Requirements

  • tools.web.fetch.enabled: true

Config

{
  tools: {
    web: {
      fetch: {
        enabled: true,
        maxChars: 50000,
        timeoutSeconds: 30,
        cacheTtlMinutes: 15,
        userAgent: "clawdbot/2026.1.14"
      }
    }
  }
}

Tool parameters

  • url (required, http/https only)
  • extractMode (markdown | text)
  • maxChars (truncate long pages)

Notes:

  • web_fetch is best-effort extraction; some sites will need the browser tool.
  • Responses are cached (default 15 minutes) to reduce repeated fetches.
  • If you use tool profiles/allowlists, add web_search/web_fetch or group:web.