vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-06 05:30:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(web-search): improve missing key guidance

Browse Source
This commit is contained in:
Peter Steinberger
2026-05-02 03:26:16 +01:00
parent a22f065043
commit 33b18f543b
11 changed files with 78 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -25,6 +25,7 @@ Docs: https://docs.openclaw.ai
- Providers/xAI: give Grok `web_search` a 60s default timeout, harden malformed xAI Responses parsing, and return structured timeout errors instead of aborting the tool call. Fixes #58063 and #58733. Thanks @dnishimura, @marvcasasola-svg, and @Nanako0129.
- Providers/configure: preserve the existing default model when adding or reauthing a provider whose plugin returns a default-model config patch. Fixes #50268. Thanks @rixcorp-oc.
- Slack/message tool: let `read` fetch an exact Slack message timestamp, including a specific thread reply when paired with `threadId`, instead of returning only the parent thread or recent channel history. Fixes #53943. Thanks @zomars.
- Web search: point missing-key errors to `web_fetch` for known URLs and the browser tool for interactive pages. Thanks @zhaoyang97.
- Heartbeat: strip legacy `[TOOL_CALL]...[/TOOL_CALL]` and `[TOOL_RESULT]...[/TOOL_RESULT]` pseudo-call blocks from heartbeat replies before channel delivery. Fixes #54138. Thanks @Deniable9570.
- macOS/Voice Wake: send wake-word and Push-to-Talk transcripts through the selected macOS session target instead of always falling back to main WebChat. Fixes #51040. Thanks @carl-jeffrolc.
- Providers/xAI: give Grok `web_search` a 60s default timeout, harden malformed xAI Responses parsing, and return structured timeout errors instead of aborting the tool call. Fixes #58063 and #58733. Thanks @dnishimura, @marvcasasola-svg, and @Nanako0129.

2
extensions/brave/src/brave-web-search-provider.runtime.ts
View File

@@ -53,7 +53,7 @@ function resolveBraveApiKey(searchConfig?: SearchConfigRecord): string | undefin
function missingBraveKeyPayload() {
return {
error: "missing_brave_api_key",
message: `web_search (brave) needs a Brave Search API key. Run \`${formatCliCommand("openclaw configure --section web")}\` to store it, or set BRAVE_API_KEY in the Gateway environment.`,
message: `web_search (brave) needs a Brave Search API key. Run \`${formatCliCommand("openclaw configure --section web")}\` to store it, or set BRAVE_API_KEY in the Gateway environment. If you do not want to configure a search API key, use web_fetch for a specific URL or the browser tool for interactive pages.`,
docs: "https://docs.openclaw.ai/tools/web",
};
}

16
extensions/brave/src/brave-web-search-provider.test.ts
View File

@@ -18,6 +18,22 @@ describe("brave web search provider", () => {
global.fetch = priorFetch;
});
it("points missing-key users to fetch/browser alternatives", async () => {
vi.stubEnv("BRAVE_API_KEY", "");
const provider = createBraveWebSearchProvider();
const tool = provider.createTool({ config: {}, searchConfig: {} });
if (!tool) {
throw new Error("Expected tool definition");
}
const result = await tool.execute({ query: "OpenClaw docs" });
expect(result).toMatchObject({
error: "missing_brave_api_key",
message: expect.stringContaining("use web_fetch for a specific URL or the browser tool"),
});
});
it("normalizes brave language parameters and swaps reversed ui/search inputs", () => {
expect(
__testing.normalizeBraveLanguageParams({

2
extensions/google/src/gemini-web-search-provider.runtime.ts
View File

@@ -152,7 +152,7 @@ export async function executeGeminiSearch(
return {
error: "missing_gemini_api_key",
message:
"web_search (gemini) needs an API key. Set GEMINI_API_KEY in the Gateway environment, or configure tools.web.search.gemini.apiKey.",
"web_search (gemini) needs an API key. Set GEMINI_API_KEY in the Gateway environment, or configure tools.web.search.gemini.apiKey. If you do not want to configure a search API key, use web_fetch for a specific URL or the browser tool for interactive pages.",
docs: "https://docs.openclaw.ai/tools/web",
};
}

17
extensions/google/web-search-provider.test.ts
View File

@@ -1,9 +1,24 @@
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-types";
import { withEnv } from "openclaw/plugin-sdk/test-env";
import { withEnv, withEnvAsync } from "openclaw/plugin-sdk/test-env";
import { describe, expect, it } from "vitest";
import { __testing, createGeminiWebSearchProvider } from "./src/gemini-web-search-provider.js";
describe("google web search provider", () => {
it("points missing-key users to fetch/browser alternatives", async () => {
await withEnvAsync({ GEMINI_API_KEY: undefined }, async () => {
const provider = createGeminiWebSearchProvider();
const tool = provider.createTool({ config: {}, searchConfig: {} });
if (!tool) {
throw new Error("Expected tool definition");
}
await expect(tool.execute({ query: "OpenClaw docs" })).resolves.toMatchObject({
error: "missing_gemini_api_key",
message: expect.stringContaining("use web_fetch for a specific URL or the browser tool"),
});
});
});
it("falls back to GEMINI_API_KEY from the environment", () => {
withEnv({ GEMINI_API_KEY: "AIza-env-test" }, () => {
expect(__testing.resolveGeminiApiKey()).toBe("AIza-env-test");

2
extensions/moonshot/src/kimi-web-search-provider.runtime.ts
View File

@@ -274,7 +274,7 @@ export async function executeKimiWebSearchProviderTool(
return {
error: "missing_kimi_api_key",
message:
"web_search (kimi) needs a Moonshot API key. Set KIMI_API_KEY or MOONSHOT_API_KEY in the Gateway environment, or configure tools.web.search.kimi.apiKey.",
"web_search (kimi) needs a Moonshot API key. Set KIMI_API_KEY or MOONSHOT_API_KEY in the Gateway environment, or configure tools.web.search.kimi.apiKey. If you do not want to configure a search API key, use web_fetch for a specific URL or the browser tool for interactive pages.",
docs: "https://docs.openclaw.ai/tools/web",
};
}

19
extensions/moonshot/src/kimi-web-search-provider.test.ts
View File

@@ -1,6 +1,8 @@
import type { OpenClawConfig } from "openclaw/plugin-sdk/provider-onboard";
import { withEnvAsync } from "openclaw/plugin-sdk/test-env";
import { describe, expect, it } from "vitest";
import { __testing } from "../test-api.js";
import { createKimiWebSearchProvider } from "./kimi-web-search-provider.js";
const kimiApiKeyEnv = ["KIMI_API", "KEY"].join("_");
@@ -24,6 +26,23 @@ function withEnv(overrides: Record<string, string>, run: () => void): void {
}
describe("kimi web search provider", () => {
it("points missing-key users to fetch/browser alternatives", async () => {
await withEnvAsync({ KIMI_API_KEY: undefined, MOONSHOT_API_KEY: undefined }, async () => {
const provider = createKimiWebSearchProvider();
const tool = provider.createTool({ config: {}, searchConfig: {} });
if (!tool) {
throw new Error("Expected tool definition");
}
const result = await tool.execute({ query: "OpenClaw docs" });
expect(result).toMatchObject({
error: "missing_kimi_api_key",
message: expect.stringContaining("use web_fetch for a specific URL or the browser tool"),
});
});
});
it("uses configured model and base url overrides with sane defaults", () => {
expect(__testing.resolveKimiModel()).toBe("kimi-k2.6");
expect(__testing.resolveKimiModel({ model: "kimi-k2" })).toBe("kimi-k2");

2
extensions/perplexity/src/perplexity-web-search-provider.runtime.ts
View File

@@ -308,7 +308,7 @@ export async function executePerplexitySearch(
return {
error: "missing_perplexity_api_key",
message:
"web_search (perplexity) needs an API key. Set PERPLEXITY_API_KEY or OPENROUTER_API_KEY in the Gateway environment, or configure tools.web.search.perplexity.apiKey.",
"web_search (perplexity) needs an API key. Set PERPLEXITY_API_KEY or OPENROUTER_API_KEY in the Gateway environment, or configure tools.web.search.perplexity.apiKey. If you do not want to configure a search API key, use web_fetch for a specific URL or the browser tool for interactive pages.",
docs: "https://docs.openclaw.ai/tools/web",
};
}

21
extensions/perplexity/src/perplexity-web-search-provider.test.ts
View File

@@ -1,5 +1,6 @@
import { withEnv } from "openclaw/plugin-sdk/test-env";
import { withEnv, withEnvAsync } from "openclaw/plugin-sdk/test-env";
import { describe, expect, it } from "vitest";
import { createPerplexityWebSearchProvider } from "./perplexity-web-search-provider.js";
import { __testing } from "./perplexity-web-search-provider.runtime.js";
const openRouterApiKeyEnv = ["OPENROUTER_API", "KEY"].join("_");
@@ -9,6 +10,24 @@ const directPerplexityApiKey = ["pplx", "test"].join("-");
const enterprisePerplexityApiKey = ["enterprise", "perplexity", "test"].join("-");
describe("perplexity web search provider", () => {
it("points missing-key users to fetch/browser alternatives", async () => {
await withEnvAsync(
{ [perplexityApiKeyEnv]: undefined, [openRouterApiKeyEnv]: undefined },
async () => {
const provider = createPerplexityWebSearchProvider();
const tool = provider.createTool({ config: {}, searchConfig: {} });
if (!tool) {
throw new Error("Expected tool definition");
}
await expect(tool.execute({ query: "OpenClaw docs" })).resolves.toMatchObject({
error: "missing_perplexity_api_key",
message: expect.stringContaining("use web_fetch for a specific URL or the browser tool"),
});
},
);
});
it("infers provider routing from api key prefixes", () => {
expect(__testing.inferPerplexityBaseUrlFromApiKey("pplx-abc")).toBe("direct");
expect(__testing.inferPerplexityBaseUrlFromApiKey("sk-or-v1-abc")).toBe("openrouter");

2
extensions/xai/src/web-search-provider.runtime.ts
View File

@@ -194,7 +194,7 @@ export async function executeXaiWebSearchProviderTool(
return {
error: "missing_xai_api_key",
message:
"web_search (grok) needs an xAI API key. Set XAI_API_KEY in the Gateway environment, or configure plugins.entries.xai.config.webSearch.apiKey.",
"web_search (grok) needs an xAI API key. Set XAI_API_KEY in the Gateway environment, or configure plugins.entries.xai.config.webSearch.apiKey. If you do not want to configure a search API key, use web_fetch for a specific URL or the browser tool for interactive pages.",
docs: "https://docs.openclaw.ai/tools/web",
};
}

1
extensions/xai/web-search.test.ts
View File

@@ -110,6 +110,7 @@ describe("xai web search config resolution", () => {
await expect(maybeTool.execute({ query: "OpenClaw" })).resolves.toMatchObject({
error: "missing_xai_api_key",
message: expect.stringContaining("use web_fetch for a specific URL or the browser tool"),
});
});
});