内置工具
Web 搜索
web_search 使用你配置的提供商搜索 Web,并返回规范化结果;结果按查询缓存 15 分钟(可配置)。OpenClaw 还内置了用于搜索 X(原 Twitter)帖子的 x_search,以及用于轻量级 URL 获取的 web_fetch。web_fetch 始终在本地运行;当提供商为 Grok 时,web_search 通过 xAI Responses 路由,而 x_search 始终使用 xAI Responses。
快速开始
选择提供商
选择提供商并完成所需设置。部分提供商无需密钥,其他提供商则需要 API key。详情请参阅下方的提供商页面。
配置
openclaw configure --section web此操作会存储提供商及所有必要的凭据。对于基于 API 的提供商,也可以改为设置该提供商的环境变量(例如 BRAVE_API_KEY),并跳过此步骤。
使用
await web_search({ query: "OpenClaw plugin SDK" });对于 X 帖子:
await x_search({ query: "dinner recipes" });选择提供商
提供带摘要的结构化结果。支持 llm-context 模式以及国家/语言筛选。提供免费套餐。
通过你的 Codex app-server 账户提供基于来源的 AI 综合回答。
无密钥提供商,无需 API key。非官方的 HTML 集成。
神经网络 + 关键词搜索,并支持内容提取(重点片段、文本、摘要)。
提供结构化结果。与 firecrawl_search 和 firecrawl_scrape 搭配使用时,最适合进行深度提取。
通过 Google Search 的来源支撑功能提供带引用的 AI 综合回答。
通过 xAI Web 来源支撑功能提供带引用的 AI 综合回答。
通过 Moonshot Web 搜索提供带引用的 AI 综合回答;无来源支撑的聊天回退会明确失败。
通过 MiniMax Token Plan 搜索 API 提供结构化结果。
通过已登录的本地 Ollama 主机或托管式 Ollama API 进行搜索。
付费 Parallel 搜索 API(PARALLEL_API_KEY);提供更高的速率限制和目标调优功能。
可选择启用且无需密钥。Parallel 的免费 Search MCP,提供针对 LLM 优化的密集摘录,无需 API key。
提供结构化结果,并支持内容提取控制和域名筛选。
自托管元搜索,无需 API key。聚合 Google、Bing、DuckDuckGo 等搜索引擎。
提供结构化结果,并支持搜索深度、主题筛选以及用于 URL 提取的 tavily_extract。
提供商比较
| 提供商 | 结果样式 | 筛选条件 | API key |
|---|---|---|---|
| Brave | 结构化摘要 | 国家、语言、时间、llm-context 模式 |
BRAVE_API_KEY |
| Codex Hosted Search | AI 综合回答 + 来源 URL | 域名、上下文大小、用户位置 | 无;使用 Codex/OpenAI 登录 |
| DuckDuckGo | 结构化摘要 | -- | 无(无需密钥) |
| Exa | 结构化结果 + 提取内容 | 神经网络/关键词模式、日期、内容提取 | EXA_API_KEY |
| Firecrawl | 结构化摘要 | 通过 firecrawl_search 工具 |
FIRECRAWL_API_KEY |
| Gemini | AI 综合回答 + 引用 | -- | GEMINI_API_KEY |
| Grok | AI 综合回答 + 引用 | -- | xAI OAuth、XAI_API_KEY 或 plugins.entries.xai.config.webSearch.apiKey |
| Kimi | AI 综合回答 + 引用;遇到无来源支撑的聊天回退时失败 | -- | KIMI_API_KEY / MOONSHOT_API_KEY |
| MiniMax Search | 结构化摘要 | 区域(global / cn) |
MINIMAX_CODE_PLAN_KEY / MINIMAX_CODING_API_KEY / MINIMAX_OAUTH_TOKEN |
| Ollama Web 搜索 | 结构化摘要 | -- | 已登录的本地主机无需密钥;直接进行 https://ollama.com 搜索时使用 OLLAMA_API_KEY |
| Parallel | 针对 LLM 上下文排序的密集摘录 | -- | PARALLEL_API_KEY(付费) |
| Parallel 搜索(免费) | 针对 LLM 上下文排序的密集摘录 | -- | 无(免费 Search MCP) |
| Perplexity | 结构化摘要 | 国家、语言、时间、域名、内容限制 | PERPLEXITY_API_KEY / OPENROUTER_API_KEY |
| SearXNG | 结构化摘要 | 类别、语言 | 无(自托管) |
| Tavily | 结构化摘要 | 通过 tavily_search 工具 |
TAVILY_API_KEY |
结果结构
web_search 会在核心工具边界规范化每个内置和外部插件提供商。调用方只会收到以下封闭结构之一:
type WebSearchOutput = | { kind: "error"; provider: string; error: "provider_error"; message: string; docs?: string; } | { kind: "results"; provider: string; query: string; count: number; tookMs?: number; results: Array<{ title: string; url: string; snippet?: string; published?: string; siteName?: string; }>; externalContent: { untrusted: true; source: "web_search"; wrapped: true; provider: string; }; cached?: true; } | { kind: "answer"; provider: string; query: string; tookMs?: number; content: string; citations?: Array<{ url: string; title?: string }>; externalContent: { untrusted: true; source: "web_search"; wrapped: true; provider: string; }; cached?: true; } | { kind: "raw"; provider: string; data: unknown; };结构化提供商使用 kind: "results";综合回答提供商使用 kind: "answer"。为保持兼容性,载荷不匹配上述任一结构的外部插件提供商将以 kind: "raw" 原样透传。在规范化分支中,不会透传原始分数、摘录、相关搜索、内联引用偏移量、模型 ID 或会话元数据等提供商特定字段。如果工作流依赖某个提供商更丰富的响应,请使用该提供商的专用工具。
externalContent.wrapped: true 是由边界本身保证为真的信任标记:提供商文本(title、snippet、siteName、content、引用标题、错误 message)会先移除所有已有的信封行,再在核心边界严格重新封装一次,因此任何提供商元数据都无法伪造该标记。query 始终是请求的查询;引用和结果 URL 必须可解析为 http(s);published 必须符合 ISO 日期格式;输出的 URL 会经过规范化;携带 error 键的载荷始终报告为 kind: "error",并在封装后的消息中保留原始提供商代码。原始透传载荷会保留提供商设置的所有标记。
自动检测
文档和设置流程中的提供商列表按字母顺序排列。自动检测使用另一套固定优先级顺序,并且只有在发现已配置的提供商时,才会选择需要凭据(requiresCredential !== false)的提供商。如果未设置 provider,OpenClaw 会按以下顺序检查提供商,并使用第一个已就绪的提供商:
优先检查基于 API 的提供商:
- Brave --
BRAVE_API_KEY或plugins.entries.brave.config.webSearch.apiKey(顺序 10) - MiniMax Search --
MINIMAX_CODE_PLAN_KEY/MINIMAX_CODING_API_KEY/MINIMAX_OAUTH_TOKEN/MINIMAX_API_KEY或plugins.entries.minimax.config.webSearch.apiKey(顺序 15) - Gemini --
plugins.entries.google.config.webSearch.apiKey、GEMINI_API_KEY或models.providers.google.apiKey(顺序 20) - Grok -- xAI OAuth、
XAI_API_KEY或plugins.entries.xai.config.webSearch.apiKey(顺序 30) - Kimi --
KIMI_API_KEY/MOONSHOT_API_KEY或plugins.entries.moonshot.config.webSearch.apiKey(顺序 40) - Perplexity --
PERPLEXITY_API_KEY/OPENROUTER_API_KEY或plugins.entries.perplexity.config.webSearch.apiKey(顺序 50) - Firecrawl --
FIRECRAWL_API_KEY或plugins.entries.firecrawl.config.webSearch.apiKey(顺序 60) - Exa --
EXA_API_KEY或plugins.entries.exa.config.webSearch.apiKey;可选的plugins.entries.exa.config.webSearch.baseUrl会覆盖 Exa 端点(顺序 65) - Tavily --
TAVILY_API_KEY或plugins.entries.tavily.config.webSearch.apiKey(顺序 70) - Parallel -- 通过
PARALLEL_API_KEY或plugins.entries.parallel.config.webSearch.apiKey使用付费 Parallel Search API;可选的plugins.entries.parallel.config.webSearch.baseUrl会覆盖端点(顺序 75)
之后是已配置端点的提供商:
- SearXNG --
SEARXNG_BASE_URL或plugins.entries.searxng.config.webSearch.baseUrl(顺序 200)
Parallel Search (Free)、DuckDuckGo、
Ollama Web 搜索和 Codex Hosted Search 等无需密钥的提供商永远不会通过自动检测胜出,
即使它们具有内部顺序值。仅当你通过 tools.web.search.provider 或
openclaw configure --section web 显式选择它们时,才会使用这些提供商。OpenClaw 不会仅仅因为没有配置基于 API 的
提供商,就将托管的 web_search 查询发送给无需密钥的提供商。
OpenAI Responses 模型是一个例外:当 tools.web.search.provider
未设置时,它们会使用 OpenAI 的原生 Web 搜索,而不是上述托管
提供商(见下文)。将 tools.web.search.provider 设置为
parallel-free(或其他提供商),即可改为通过托管路径路由这些模型。
OpenAI 原生 Web 搜索
直接使用的 OpenAI Responses 模型(api: "openai-responses"、提供商 openai、
未设置基础 URL 或使用官方 OpenAI API 基础 URL)会在 OpenClaw Web 搜索已启用且未固定任何
托管提供商时,自动使用 OpenAI 托管的 web_search 工具。这是内置
OpenAI 插件中由提供商负责的行为,不适用于 OpenAI 兼容代理基础 URL 或 Azure
路由。将 tools.web.search.provider 设置为其他提供商(如 brave),可让 OpenAI 模型
继续使用托管的 web_search 工具;也可设置
tools.web.search.enabled: false,同时禁用托管搜索和 OpenAI 原生搜索。
Codex 原生 Web 搜索
Codex app-server 运行时会在 Web 搜索已启用且未选择托管提供商时,自动使用 Codex 托管的
web_search 工具。原生托管搜索与 OpenClaw 托管的 web_search 动态工具互斥,
因此托管搜索无法绕过原生域名限制。当托管搜索不可用、被显式禁用或
被选定的托管提供商取代时,OpenClaw 会使用托管工具。OpenClaw 会保持禁用 Codex 的独立
web.run 扩展(features.standalone_web_search: false),
因为生产环境的 app-server 流量会拒绝其用户定义的 web
命名空间。
- 在
tools.web.search.openaiCodex下配置原生搜索 - 设置
tools.web.search.provider: "codex",可将 Codex Hosted Search 配置为 任意父模型的托管web_search提供商。每次调用都会运行一次 有界的临时 Codex app-server 轮次;如果 Codex 未发出托管的webSearch项目,调用就会失败。 mode: "cached"是默认偏好,但 Codex 会将其解析为不受限 app-server 轮次的实时 外部访问;设置"live"可显式请求实时访问- 将
tools.web.search.provider设置为brave等托管提供商,可改用 OpenClaw 托管的web_search - 设置
tools.web.search.openaiCodex.enabled: false可选择退出 Codex 托管的 搜索;其他托管提供商仍然可用 - 限制 Codex 原生工具界面时,托管的
web_search仍然可用 - 设置
allowedDomains后,如果托管搜索不可用,自动托管回退将以失败关闭, 从而确保原生允许列表无法被绕过 - 禁用工具的纯 LLM 运行会同时禁用原生搜索和托管搜索
tools.web.search.enabled: false会同时禁用托管搜索和原生搜索
对持久生效的 Codex 搜索策略进行更改时,会启动一个新的绑定线程,以免 已加载的 app-server 线程继续保留过期的托管搜索访问权限。 每轮的临时限制会使用一个临时受限线程,并保留 现有绑定以供后续恢复。
直接的 OpenAI ChatGPT Responses 流量也可以使用 OpenAI 托管的
web_search 工具。这条独立路径仍需通过
tools.web.search.openaiCodex.enabled: true 主动启用,并且仅适用于使用 api: "openai-chatgpt-responses" 的合格
openai/* 模型。
{ tools: { web: { search: { enabled: true, // 可选:也从非 Codex 父模型使用 Codex Hosted Search。 provider: "codex", openaiCodex: { enabled: true, mode: "cached", allowedDomains: ["example.com"], contextSize: "high", userLocation: { country: "US", city: "New York", timezone: "America/New_York", }, }, }, }, },}对于不支持 Codex 原生搜索的运行时和提供商,Codex 可以
通过 OpenClaw 的动态工具命名空间使用托管的 web_search 回退。
如果需要使用 OpenClaw 特定于提供商的网络控制,而不是 Codex 托管搜索,
请显式选择托管提供商。
选择 provider: "codex" 会启用内置的 codex 插件,并使用
上述相同的 tools.web.search.openaiCodex 限制。请先使用
openclaw models auth login --provider openai 对 Codex app-server 进行身份验证。
父智能体可以使用任意模型或运行时;只有有界搜索工作进程
通过 Codex 运行。
网络安全
托管 HTTP web_search 提供商调用使用 OpenClaw 的受保护提取路径,
作用域限制为当前提供商自身的主机名。仅针对该主机名,
OpenClaw 允许 198.18.0.0/15 和 fc00::/7 中由 Surge、Clash 和 sing-box 返回的假 IP DNS 答案。其他私有、环回、链路本地和
元数据目标仍会被阻止。Codex Hosted Search 是例外:
其有界工作进程会将网络访问委托给 Codex app-server 托管的
web_search 工具。
此自动许可不适用于任意 web_fetch URL。对于
web_fetch,仅当你的可信代理拥有这些合成地址范围时,才应显式启用
tools.web.fetch.ssrfPolicy.allowRfc2544BenchmarkRange 和
tools.web.fetch.ssrfPolicy.allowIpv6UniqueLocalRange。
配置
{ tools: { web: { search: { enabled: true, // 默认值:true provider: "brave", // 或省略以使用自动检测 maxResults: 5, timeoutSeconds: 30, cacheTtlMinutes: 15, }, }, },}特定于提供商的配置(API 密钥、基础 URL、模式)位于
plugins.entries.<plugin>.config.webSearch.* 下。Gemini 还可以复用
models.providers.google.apiKey 和 models.providers.google.baseUrl,作为其专用 Web 搜索配置和 GEMINI_API_KEY 之后优先级较低的
回退。示例请参阅
各提供商页面。
Grok 还可以复用 openclaw models auth login --provider xai --method oauth 中的 xAI OAuth 身份验证配置文件;API 密钥配置仍作为回退。
tools.web.search.provider 会依据内置和已安装插件清单所声明的 Web 搜索提供商 ID
进行验证。像 "brvae" 这样的拼写错误
会导致配置验证失败,而不会静默回退到自动检测。如果某个
已配置提供商仅有过期的插件依据,例如卸载第三方插件后残留的
plugins.entries.<plugin> 块,
OpenClaw 会保持启动过程的韧性并报告警告,以便你重新安装
插件或运行 openclaw doctor --fix 清理过期配置。
web_fetch 回退提供商的选择是独立的:
- 通过
tools.web.fetch.provider选择 - 或省略该字段,让 OpenClaw 根据已配置的凭据自动检测第一个就绪的 Web 提取 提供商
- 非沙箱隔离的
web_fetch可以使用声明了contracts.webFetchProviders的已安装插件提供商;沙箱隔离的提取允许使用内置提供商和 经验证的官方插件安装,但排除第三方外部插件 - 官方 Firecrawl 插件是目前唯一内置的
webFetchProviders贡献者,其配置位于plugins.entries.firecrawl.config.webFetch.*下
当你在 openclaw onboard 或
openclaw configure --section web 期间选择 Kimi 时,OpenClaw 还可以询问:
- Moonshot API 区域(
https://api.moonshot.ai/v1或https://api.moonshot.cn/v1) - 默认 Kimi Web 搜索模型(默认为
kimi-k2.6)
对于 x_search,请配置 plugins.entries.xai.config.xSearch.*。它使用与聊天相同的
xAI 身份验证配置文件,或 Grok Web 搜索所用的 XAI_API_KEY / 插件 Web 搜索
凭据。
旧版 tools.web.x_search.* 配置会由 openclaw doctor --fix 自动迁移。
当你在 openclaw onboard 或 openclaw configure --section web 期间选择 Grok 时,
OpenClaw 还会在 Grok 设置完成后,使用相同凭据提供可选的 x_search 设置。这是 Grok
路径中的一个独立后续步骤,而不是单独的顶层 Web 搜索提供商选项。如果你选择其他
提供商,OpenClaw 不会显示 x_search 提示。
存储 API 密钥
配置文件
运行 openclaw configure --section web 或直接设置密钥:
{ plugins: { entries: { brave: { config: { webSearch: { apiKey: "YOUR_KEY", // pragma: allowlist secret }, }, }, }, },}环境变量
在 Gateway 网关进程环境中设置提供商环境变量:
export BRAVE_API_KEY="YOUR_KEY"对于 Gateway 网关安装,请将其放入 ~/.openclaw/.env。
请参阅环境变量。
工具参数
| 参数 | 描述 |
|---|---|
query |
搜索查询(必填) |
count |
返回的结果数(1-10,默认值:5) |
country |
2 字母 ISO 国家/地区代码(例如 "US"、"DE") |
language |
ISO 639-1 语言代码(例如 "en"、"de") |
search_lang |
搜索语言代码(仅限 Brave) |
freshness |
时间筛选条件:day、week、month 或 year |
date_after |
此日期之后的结果(YYYY-MM-DD) |
date_before |
此日期之前的结果(YYYY-MM-DD) |
ui_lang |
UI 语言代码(仅限 Brave) |
domain_filter |
域名允许列表/拒绝列表数组(仅限 Perplexity) |
max_tokens |
总内容 token 预算,仅限原生 Perplexity Search API |
max_tokens_per_page |
每页提取 token 上限,仅限原生 Perplexity Search API |
x_search
x_search 使用 xAI 查询 X(原 Twitter)帖子,并返回
带引用的 AI 综合答案。它接受自然语言查询和
可选的结构化筛选条件。OpenClaw 会为每个请求构造内置的 xAI x_search
工具,而不会将其永久注册,因此该工具仅在实际调用它的轮次中
处于活动状态。
x_search 配置
省略 enabled 时,仅当活动模型的
提供商为 xai 且能解析到 xAI 凭据时,才会公开 x_search。对于使用已知
非 xAI 提供商的活动模型,将 plugins.entries.xai.config.xSearch.enabled 设为 true 可
选择启用跨提供商使用。如果活动模型提供商缺失或
无法解析,该工具将保持隐藏。将 enabled 设为 false 可对
所有提供商禁用该工具。始终需要 xAI 凭据。
{ plugins: { entries: { xai: { config: { xSearch: { enabled: true, // 使用已知非 xAI 模型提供商时必需 model: "grok-4.3", baseUrl: "https://api.x.ai/v1", // 可选,覆盖 webSearch.baseUrl inlineCitations: false, maxTurns: 2, timeoutSeconds: 30, cacheTtlMinutes: 15, }, webSearch: { apiKey: "xai-...", // 如果已设置 xAI 身份验证配置文件或 XAI_API_KEY,则为可选 baseUrl: "https://api.x.ai/v1", // 可选的共享 xAI Responses 基础 URL }, }, }, }, },}设置 plugins.entries.xai.config.xSearch.baseUrl 后,x_search 会向 <baseUrl>/responses
发送 POST 请求。如果省略该字段,
则回退到 plugins.entries.xai.config.webSearch.baseUrl,然后回退到
公共 xAI 端点(https://api.x.ai/v1)。
x_search 参数
| 参数 | 描述 |
|---|---|
query |
搜索查询(必填) |
allowed_x_handles |
将结果限制为最多 20 个 X 用户名 |
excluded_x_handles |
排除最多 20 个 X 用户名 |
from_date |
仅包含此日期当日或之后的帖子(YYYY-MM-DD) |
to_date |
仅包含此日期当日或之前的帖子(YYYY-MM-DD) |
enable_image_understanding |
允许 xAI 检查匹配帖子所附的图片 |
enable_video_understanding |
允许 xAI 检查匹配帖子所附的视频 |
allowed_x_handles 和 excluded_x_handles 互斥。
x_search 示例
await x_search({ query: "dinner recipes", allowed_x_handles: ["nytfood"], from_date: "2026-03-01",});// 单篇帖子统计数据:尽可能使用确切的状态 URL 或状态 IDawait x_search({ query: "https://x.com/huntharo/status/1905678901234567890",});示例
// 基本搜索await web_search({ query: "OpenClaw plugin SDK" }); // 针对德语的搜索await web_search({ query: "TV online schauen", country: "DE", language: "de" }); // 近期结果(过去一周)await web_search({ query: "AI developments", freshness: "week" }); // 日期范围await web_search({ query: "climate research", date_after: "2024-01-01", date_before: "2024-06-30",}); // 域名筛选(仅限 Perplexity)await web_search({ query: "product reviews", domain_filter: ["-reddit.com", "-pinterest.com"],});工具配置文件
如果使用工具配置文件或允许列表,请添加 web_search、x_search 或 group:web:
{ tools: { allow: ["web_search", "x_search"], // 或:allow: ["group:web"] (包括 web_search、x_search 和 web_fetch) },}相关内容
- Web Fetch —— 获取 URL 并提取可读内容
- Web Browser —— 对大量使用 JS 的网站进行完整浏览器自动化
- Grok Search —— 使用 Grok 作为
web_search提供商 - Ollama Web 搜索 —— 通过你的 Ollama 主机进行无需密钥的 Web 搜索