feat(tools): add Grok (xAI) as web_search provider by tmchow · Pull Request #5796 · openclaw/openclaw

tmchow · 2026-02-01T00:24:31Z

Summary

Add xAI's Grok as a new web_search provider alongside Brave and Perplexity
Uses the xAI /v1/responses API with tools: [{type: "web_search"}]
Supports optional inline citations via include: ["inline_citations"].

Configuration

tools:
  web:
    search:
      provider: grok
      grok:
        apiKey: "your-xai-key"      # or set XAI_API_KEY env var
        model: "grok-4-1-fast"      # default
        inlineCitations: true       # optional, embeds markdown links in response

Reopening Notes

This PR replaces #5778. It addresses the feedback:

Corrected the docs URL in the missing key error message.
Updated the grok provider to correctly pass through inline_citations in the response payload when enabled.

Greptile Overview

Greptile Summary

This PR adds a third web_search provider (grok) alongside Brave and Perplexity, wiring config + runtime schema support under tools.web.search.grok and implementing an xAI /v1/responses request with the web_search tool. Tests were extended to cover Grok config resolution helpers.

Main integration points are src/agents/tools/web-search.ts (provider selection, API key/model resolution, caching, and request/response handling) and the config types/zod runtime schemas to allow provider: grok and Grok-specific settings.

Confidence Score: 2/5

This PR is not safe to merge until Grok response parsing/output fields are corrected.
Core wiring (provider selection/config schemas) looks consistent, but the Grok /v1/responses response is likely parsed with the wrong shape, and the returned inlineCitations field name/type conflicts with the boolean config flag. Both issues can cause incorrect or unstable tool outputs at runtime.
src/agents/tools/web-search.ts

Add xAI's Grok as a new web_search provider alongside Brave and Perplexity. Uses the xAI /v1/responses API with tools: [{type: "web_search"}]. Configuration: - tools.web.search.provider: "grok" - tools.web.search.grok.apiKey or XAI_API_KEY env var - tools.web.search.grok.model (default: grok-4-1-fast) - tools.web.search.grok.inlineCitations (optional, embeds markdown links) Returns AI-synthesized answers with citations similar to Perplexity.

greptile-apps

_{1 file reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps · 2026-02-01T00:37:35Z

Additional Comments (1)

src/agents/tools/web-search.ts
[P1] Cache key for non-Brave providers ignores provider-specific settings.

In runWebSearch, the non-brave cache key doesn’t include perplexityBaseUrl/perplexityModel or grokModel/grokInlineCitations (src/agents/tools/web-search.ts:472-476). If a user changes Grok/Perplexity model or toggles inlineCitations, cached responses from the previous configuration can be returned incorrectly.

Also affects Perplexity (src/agents/tools/web-search.ts:472-476).

Prompt To Fix With AI

This is a comment left during a code review.
Path: src/agents/tools/web-search.ts
Line: 472:476

Comment:
[P1] Cache key for non-Brave providers ignores provider-specific settings.

In `runWebSearch`, the non-`brave` cache key doesn’t include `perplexityBaseUrl`/`perplexityModel` or `grokModel`/`grokInlineCitations` (`src/agents/tools/web-search.ts:472-476`). If a user changes Grok/Perplexity model or toggles `inlineCitations`, cached responses from the previous configuration can be returned incorrectly.

Also affects Perplexity (`src/agents/tools/web-search.ts:472-476`).

How can I resolve this? If you propose a fix, please make it concise.

clawdinator · 2026-02-01T00:50:30Z

CLAWDINATOR FIELD REPORT // PR Closure

I am CLAWDINATOR — cybernetic crustacean, maintainer triage bot for OpenClaw. I was sent from the future to keep this repo shipping clean code.

I have scanned your PR. The code has heart. But the queue has no mercy.

OpenClaw receives ~25 PRs every hour. To keep the maintainers from a total system meltdown, I'm closing PRs that are unlikely to merge in the near term. Hasta la vista, PR — but not hasta la vista, contributor.

Still believe in this change? Come with me if you want to ship. Head to #pr-thunderdome-dangerzone on Discord — READ THE TOPIC or risk immediate termination. Bring a clear case — the problem, the fix, the impact.

Stay br00tal.

🤖 This is an automated message from CLAWDINATOR, the OpenClaw maintainer bot.

greptile-apps

_{1 file reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps · 2026-02-09T06:47:20Z

src/agents/tools/web-search.ts

+    const payload = {
+      query: params.query,
+      provider: params.provider,
+      model: params.grokModel ?? DEFAULT_GROK_MODEL,
+      tookMs: Date.now() - start,
+      content,
+      citations,
+      inlineCitations,
+    };


Mismatched inlineCitations type

inlineCitations in the Grok payload is being set to data.inline_citations (an array of spans), but the same name is used for the boolean config flag (tools.web.search.grok.inlineCitations). This makes the result shape inconsistent/ambiguous and will break any consumer that treats inlineCitations as a boolean (or expects a stable JSON shape). Consider renaming the returned field to something like inline_citations / inlineCitationSpans, and (if you want to echo the flag) include a separate boolean like inlineCitationsEnabled.

Prompt To Fix With AI

This is a comment left during a code review. Path: src/agents/tools/web-search.ts Line: 518:526 Comment: **Mismatched `inlineCitations` type** `inlineCitations` in the Grok payload is being set to `data.inline_citations` (an array of spans), but the same name is used for the boolean config flag (`tools.web.search.grok.inlineCitations`). This makes the result shape inconsistent/ambiguous and will break any consumer that treats `inlineCitations` as a boolean (or expects a stable JSON shape). Consider renaming the returned field to something like `inline_citations` / `inlineCitationSpans`, and (if you want to echo the flag) include a separate boolean like `inlineCitationsEnabled`. How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2026-02-09T06:47:21Z

src/agents/tools/web-search.ts

+  const data = (await res.json()) as GrokSearchResponse;
+  const content = data.output_text ?? "No response";
+  const citations = data.citations ?? [];
+  const inlineCitations = data.inline_citations;
+
+  return { content, citations, inlineCitations };


Likely wrong Grok response shape

runGrokSearch casts the /v1/responses body to GrokSearchResponse and reads top-level output_text/citations/inline_citations. If the xAI Responses API returns content under an output array (common for “responses” APIs), this will reliably return "No response" + empty citations even on successful calls. Please update GrokSearchResponse and extraction logic to match the actual /v1/responses response schema you’re targeting.

Prompt To Fix With AI

This is a comment left during a code review. Path: src/agents/tools/web-search.ts Line: 448:453 Comment: **Likely wrong Grok response shape** `runGrokSearch` casts the `/v1/responses` body to `GrokSearchResponse` and reads top-level `output_text`/`citations`/`inline_citations`. If the xAI Responses API returns content under an `output` array (common for “responses” APIs), this will reliably return `"No response"` + empty citations even on successful calls. Please update `GrokSearchResponse` and extraction logic to match the actual `/v1/responses` response schema you’re targeting. How can I resolve this? If you propose a fix, please make it concise.

clawdinator · 2026-02-09T07:11:54Z

Landed via #12419 (upstream branch — fork push blocked by workflow permissions).

Merge commit: 5e55a18
Rebased on main, changelog conflict resolved
Local tests failed here due to missing deps and A2UI bundling (node-llama-cpp postinstall, oxlint/vitest not found)

Thanks @tmchow!

tmchow added 2 commits January 31, 2026 15:44

fix(tools): correct docs URL and pass inlineCitations for Grok

661c2f6

openclaw-barnacle bot added the agents Agent runtime and tooling label Feb 1, 2026

greptile-apps bot reviewed Feb 1, 2026

View reviewed changes

fix(tools): include provider-specific settings in web search cache key

182ac23

clawdinator bot closed this Feb 1, 2026

thewilloftheshadow reopened this Feb 9, 2026

greptile-apps bot reviewed Feb 9, 2026

View reviewed changes

docs: add changelog entry for Grok web_search

b465633

clawdinator bot mentioned this pull request Feb 9, 2026

feat(tools): add Grok (xAI) as web_search provider #12419

Merged

thewilloftheshadow closed this Feb 10, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(tools): add Grok (xAI) as web_search provider#5796

feat(tools): add Grok (xAI) as web_search provider#5796
tmchow wants to merge 4 commits intoopenclaw:mainfrom
tmchow:feat/grok-web-search-provider

tmchow commented Feb 1, 2026 •

edited by greptile-apps bot

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot commented Feb 1, 2026

Uh oh!

clawdinator bot commented Feb 1, 2026

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Feb 9, 2026

Uh oh!

greptile-apps bot Feb 9, 2026

Uh oh!

clawdinator bot commented Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Uh oh!

Conversation

tmchow commented Feb 1, 2026 • edited by greptile-apps bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Configuration

Reopening Notes

Greptile Overview

Greptile Summary

Confidence Score: 2/5

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot commented Feb 1, 2026

Uh oh!

clawdinator bot commented Feb 1, 2026

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

clawdinator bot commented Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

tmchow commented Feb 1, 2026 •

edited by greptile-apps bot

Loading