feat(plugins): add web search runtime capability

src/agents/tools/web-search.ts

@@ -1,148 +1,29 @@
 import type { OpenClawConfig } from "../../config/config.js";
-import { normalizeResolvedSecretInputString } from "../../config/types.secrets.js";
-import { logVerbose } from "../../globals.js";
-import { resolvePluginWebSearchProviders } from "../../plugins/web-search-providers.js";
 import type { RuntimeWebSearchMetadata } from "../../secrets/runtime-web-tools.types.js";
-import { normalizeSecretInput } from "../../utils/normalize-secret-input.js";
+import { __testing as runtimeTesting } from "../../web-search/runtime.js";
 import type { AnyAgentTool } from "./common.js";
-import { jsonResult } from "./common.js";
-import { __testing as coreTesting } from "./web-search-core.js";
-
-type WebSearchConfig = NonNullable<OpenClawConfig["tools"]>["web"] extends infer Web
-  ? Web extends { search?: infer Search }
-    ? Search
-    : undefined
-  : undefined;
-
-function resolveSearchConfig(cfg?: OpenClawConfig): WebSearchConfig {
-  const search = cfg?.tools?.web?.search;
-  if (!search || typeof search !== "object") {
-    return undefined;
-  }
-  return search as WebSearchConfig;
-}
-
-function resolveSearchEnabled(params: { search?: WebSearchConfig; sandboxed?: boolean }): boolean {
-  if (typeof params.search?.enabled === "boolean") {
-    return params.search.enabled;
-  }
-  if (params.sandboxed) {
-    return true;
-  }
-  return true;
-}
-
-function readProviderEnvValue(envVars: string[]): string | undefined {
-  for (const envVar of envVars) {
-    const value = normalizeSecretInput(process.env[envVar]);
-    if (value) {
-      return value;
-    }
-  }
-  return undefined;
-}
-
-function hasProviderCredential(providerId: string, search: WebSearchConfig | undefined): boolean {
-  const providers = resolvePluginWebSearchProviders({
-    bundledAllowlistCompat: true,
-  });
-  const provider = providers.find((entry) => entry.id === providerId);
-  if (!provider) {
-    return false;
-  }
-  const rawValue = provider.getCredentialValue(search as Record<string, unknown> | undefined);
-  const fromConfig = normalizeSecretInput(
-    normalizeResolvedSecretInputString({
-      value: rawValue,
-      path:
-        providerId === "brave"
-          ? "tools.web.search.apiKey"
-          : `tools.web.search.${providerId}.apiKey`,
-    }),
-  );
-  return Boolean(fromConfig || readProviderEnvValue(provider.envVars));
-}
-
-function resolveSearchProvider(search?: WebSearchConfig): string {
-  const providers = resolvePluginWebSearchProviders({
-    bundledAllowlistCompat: true,
-  });
-  const raw =
-    search && "provider" in search && typeof search.provider === "string"
-      ? search.provider.trim().toLowerCase()
-      : "";
-
-  if (raw) {
-    const explicit = providers.find((provider) => provider.id === raw);
-    if (explicit) {
-      return explicit.id;
-    }
-  }
-
-  if (!raw) {
-    for (const provider of providers) {
-      if (!hasProviderCredential(provider.id, search)) {
-        continue;
-      }
-      logVerbose(
-        `web_search: no provider configured, auto-detected "${provider.id}" from available API keys`,
-      );
-      return provider.id;
-    }
-  }
-
-  return providers[0]?.id ?? "brave";
-}
+import {
+  __testing as coreTesting,
+  createWebSearchTool as createWebSearchToolCore,
+} from "./web-search-core.js";
 
 export function createWebSearchTool(options?: {
   config?: OpenClawConfig;
   sandboxed?: boolean;
   runtimeWebSearch?: RuntimeWebSearchMetadata;
 }): AnyAgentTool | null {
-  const search = resolveSearchConfig(options?.config);
-  if (!resolveSearchEnabled({ search, sandboxed: options?.sandboxed })) {
-    return null;
-  }
-
-  const providers = resolvePluginWebSearchProviders({
-    config: options?.config,
-    bundledAllowlistCompat: true,
-  });
-  if (providers.length === 0) {
-    return null;
-  }
-
-  const providerId =
-    options?.runtimeWebSearch?.selectedProvider ??
-    options?.runtimeWebSearch?.providerConfigured ??
-    resolveSearchProvider(search);
-  const provider =
-    providers.find((entry) => entry.id === providerId) ??
-    providers.find((entry) => entry.id === resolveSearchProvider(search)) ??
-    providers[0];
-  if (!provider) {
-    return null;
-  }
-
-  const definition = provider.createTool({
-    config: options?.config,
-    searchConfig: search as Record<string, unknown> | undefined,
-    runtimeMetadata: options?.runtimeWebSearch,
-  });
-  if (!definition) {
-    return null;
-  }
-
-  return {
-    label: "Web Search",
-    name: "web_search",
-    description: definition.description,
-    parameters: definition.parameters,
-    execute: async (_toolCallId, args) => jsonResult(await definition.execute(args)),
-  };
+  return createWebSearchToolCore(options);
 }
 
 export const __testing = {
   ...coreTesting,
-  resolveSearchProvider,
+  resolveSearchProvider: (
+    search?: OpenClawConfig["tools"] extends infer Tools
+      ? Tools extends { web?: infer Web }
+        ? Web extends { search?: infer Search }
+          ? Search
+          : undefined
+        : undefined
+      : undefined,
+  ) => runtimeTesting.resolveWebSearchProviderId({ search }),
 };

src/agents/tools/web-tools.enabled-defaults.test.ts

@@ -325,9 +325,16 @@ describe("web_search provider proxy dispatch", () => {
 
 describe("web_search perplexity Search API", () => {
   const priorFetch = global.fetch;
+  const savedEnv = { ...process.env };
+
+  beforeEach(() => {
+    delete process.env.PERPLEXITY_API_KEY;
+    delete process.env.OPENROUTER_API_KEY;
+  });
 
   afterEach(() => {
     vi.unstubAllEnvs();
+    process.env = { ...savedEnv };
     global.fetch = priorFetch;
     webSearchTesting.SEARCH_CACHE.clear();
   });
@@ -462,9 +469,16 @@ describe("web_search perplexity Search API", () => {
 
 describe("web_search perplexity OpenRouter compatibility", () => {
   const priorFetch = global.fetch;
+  const savedEnv = { ...process.env };
+
+  beforeEach(() => {
+    delete process.env.PERPLEXITY_API_KEY;
+    delete process.env.OPENROUTER_API_KEY;
+  });
 
   afterEach(() => {
     vi.unstubAllEnvs();
+    process.env = { ...savedEnv };
     global.fetch = priorFetch;
     webSearchTesting.SEARCH_CACHE.clear();
   });

src/plugins/runtime/index.test.ts

@@ -2,14 +2,8 @@ import { beforeEach, describe, expect, it, vi } from "vitest";
 import { DEFAULT_MODEL, DEFAULT_PROVIDER } from "../../agents/defaults.js";
 import { onAgentEvent } from "../../infra/agent-events.js";
 import { requestHeartbeatNow } from "../../infra/heartbeat-wake.js";
+import * as execModule from "../../process/exec.js";
 import { onSessionTranscriptUpdate } from "../../sessions/transcript-events.js";
-
-const runCommandWithTimeoutMock = vi.hoisted(() => vi.fn());
-
-vi.mock("../../process/exec.js", () => ({
-  runCommandWithTimeout: (...args: unknown[]) => runCommandWithTimeoutMock(...args),
-}));
-
 import {
   clearGatewaySubagentRuntime,
   createPluginRuntime,
@@ -18,20 +12,24 @@ import {
 
 describe("plugin runtime command execution", () => {
   beforeEach(() => {
-    runCommandWithTimeoutMock.mockClear();
+    vi.restoreAllMocks();
     clearGatewaySubagentRuntime();
   });
 
   it("exposes runtime.system.runCommandWithTimeout by default", async () => {
     const commandResult = {
+      pid: 12345,
       stdout: "hello\n",
       stderr: "",
       code: 0,
       signal: null,
       killed: false,
+      noOutputTimedOut: false,
       termination: "exit" as const,
     };
-    runCommandWithTimeoutMock.mockResolvedValue(commandResult);
+    const runCommandWithTimeoutMock = vi
+      .spyOn(execModule, "runCommandWithTimeout")
+      .mockResolvedValue(commandResult);
 
     const runtime = createPluginRuntime();
     await expect(
@@ -41,7 +39,9 @@ describe("plugin runtime command execution", () => {
   });
 
   it("forwards runtime.system.runCommandWithTimeout errors", async () => {
-    runCommandWithTimeoutMock.mockRejectedValue(new Error("boom"));
+    const runCommandWithTimeoutMock = vi
+      .spyOn(execModule, "runCommandWithTimeout")
+      .mockRejectedValue(new Error("boom"));
     const runtime = createPluginRuntime();
     await expect(
       runtime.system.runCommandWithTimeout(["echo", "hello"], { timeoutMs: 1000 }),
@@ -63,6 +63,12 @@ describe("plugin runtime command execution", () => {
     expect(runtime.mediaUnderstanding.transcribeAudioFile).toBe(runtime.stt.transcribeAudioFile);
   });
 
+  it("exposes runtime.webSearch helpers", () => {
+    const runtime = createPluginRuntime();
+    expect(typeof runtime.webSearch.listProviders).toBe("function");
+    expect(typeof runtime.webSearch.search).toBe("function");
+  });
+
   it("exposes runtime.system.requestHeartbeatNow", () => {
     const runtime = createPluginRuntime();
     expect(runtime.system.requestHeartbeatNow).toBe(requestHeartbeatNow);

src/plugins/runtime/index.ts

@@ -11,6 +11,7 @@ import {
   transcribeAudioFile,
 } from "../../media-understanding/runtime.js";
 import { listSpeechVoices, textToSpeech, textToSpeechTelephony } from "../../tts/tts.js";
+import { listWebSearchProviders, runWebSearch } from "../../web-search/runtime.js";
 import { createRuntimeAgent } from "./runtime-agent.js";
 import { createRuntimeChannel } from "./runtime-channel.js";
 import { createRuntimeConfig } from "./runtime-config.js";
@@ -147,6 +148,10 @@ export function createPluginRuntime(_options: CreatePluginRuntimeOptions = {}):
       describeVideoFile,
       transcribeAudioFile,
     },
+    webSearch: {
+      listProviders: listWebSearchProviders,
+      search: runWebSearch,
+    },
     stt: { transcribeAudioFile },
     tools: createRuntimeTools(),
     channel: createRuntimeChannel(),

src/plugins/runtime/types-core.ts

@@ -57,6 +57,10 @@ export type PluginRuntimeCore = {
     describeVideoFile: typeof import("../../media-understanding/runtime.js").describeVideoFile;
     transcribeAudioFile: typeof import("../../media-understanding/runtime.js").transcribeAudioFile;
   };
+  webSearch: {
+    listProviders: typeof import("../../web-search/runtime.js").listWebSearchProviders;
+    search: typeof import("../../web-search/runtime.js").runWebSearch;
+  };
   stt: {
     transcribeAudioFile: typeof import("../../media-understanding/transcribe-audio.js").transcribeAudioFile;
   };

src/plugins/web-search-providers.test.ts

@@ -1,7 +1,16 @@
-import { describe, expect, it } from "vitest";
-import { resolvePluginWebSearchProviders } from "./web-search-providers.js";
+import { afterEach, describe, expect, it } from "vitest";
+import { createEmptyPluginRegistry } from "./registry.js";
+import { setActivePluginRegistry } from "./runtime.js";
+import {
+  resolvePluginWebSearchProviders,
+  resolveRuntimeWebSearchProviders,
+} from "./web-search-providers.js";
 
 describe("resolvePluginWebSearchProviders", () => {
+  afterEach(() => {
+    setActivePluginRegistry(createEmptyPluginRegistry());
+  });
+
   it("returns bundled providers in auto-detect order", () => {
     const providers = resolvePluginWebSearchProviders({});
 
@@ -72,4 +81,36 @@ describe("resolvePluginWebSearchProviders", () => {
 
     expect(providers).toEqual([]);
   });
+
+  it("prefers the active plugin registry for runtime resolution", () => {
+    const registry = createEmptyPluginRegistry();
+    registry.webSearchProviders.push({
+      pluginId: "custom-search",
+      pluginName: "Custom Search",
+      provider: {
+        id: "custom",
+        label: "Custom Search",
+        hint: "Custom runtime provider",
+        envVars: ["CUSTOM_SEARCH_API_KEY"],
+        placeholder: "custom-...",
+        signupUrl: "https://example.com/signup",
+        autoDetectOrder: 1,
+        getCredentialValue: () => "configured",
+        setCredentialValue: () => {},
+        createTool: () => ({
+          description: "custom",
+          parameters: {},
+          execute: async () => ({}),
+        }),
+      },
+      source: "test",
+    });
+    setActivePluginRegistry(registry);
+
+    const providers = resolveRuntimeWebSearchProviders({});
+
+    expect(providers.map((provider) => `${provider.pluginId}:${provider.id}`)).toEqual([
+      "custom-search:custom",
+    ]);
+  });
 });

src/plugins/web-search-providers.ts

@@ -12,6 +12,7 @@ import {
 } from "./bundled-compat.js";
 import { normalizePluginsConfig, resolveEffectiveEnableState } from "./config-state.js";
 import type { PluginLoadOptions } from "./loader.js";
+import { getActivePluginRegistry } from "./runtime.js";
 import type { PluginWebSearchProviderEntry } from "./types.js";
 
 const BUNDLED_WEB_SEARCH_ALLOWLIST_COMPAT_PLUGIN_IDS = [
@@ -127,25 +128,47 @@ export function resolvePluginWebSearchProviders(params: {
   });
   const normalizedPlugins = normalizePluginsConfig(config?.plugins);
 
-  return BUNDLED_WEB_SEARCH_PROVIDER_REGISTRY.filter(
-    ({ pluginId }) =>
-      resolveEffectiveEnableState({
-        id: pluginId,
-        origin: "bundled",
-        config: normalizedPlugins,
-        rootConfig: config,
-      }).enabled,
-  )
-    .map((entry) => ({
+  return sortWebSearchProviders(
+    BUNDLED_WEB_SEARCH_PROVIDER_REGISTRY.filter(
+      ({ pluginId }) =>
+        resolveEffectiveEnableState({
+          id: pluginId,
+          origin: "bundled",
+          config: normalizedPlugins,
+          rootConfig: config,
+        }).enabled,
+    ).map((entry) => ({
       ...entry.provider,
       pluginId: entry.pluginId,
-    }))
-    .toSorted((a, b) => {
-      const aOrder = a.autoDetectOrder ?? Number.MAX_SAFE_INTEGER;
-      const bOrder = b.autoDetectOrder ?? Number.MAX_SAFE_INTEGER;
-      if (aOrder !== bOrder) {
-        return aOrder - bOrder;
-      }
-      return a.id.localeCompare(b.id);
-    });
+    })),
+  );
+}
+
+function sortWebSearchProviders(
+  providers: PluginWebSearchProviderEntry[],
+): PluginWebSearchProviderEntry[] {
+  return providers.toSorted((a, b) => {
+    const aOrder = a.autoDetectOrder ?? Number.MAX_SAFE_INTEGER;
+    const bOrder = b.autoDetectOrder ?? Number.MAX_SAFE_INTEGER;
+    if (aOrder !== bOrder) {
+      return aOrder - bOrder;
+    }
+    return a.id.localeCompare(b.id);
+  });
+}
+
+export function resolveRuntimeWebSearchProviders(params: {
+  config?: PluginLoadOptions["config"];
+  bundledAllowlistCompat?: boolean;
+}): PluginWebSearchProviderEntry[] {
+  const runtimeProviders = getActivePluginRegistry()?.webSearchProviders ?? [];
+  if (runtimeProviders.length > 0) {
+    return sortWebSearchProviders(
+      runtimeProviders.map((entry) => ({
+        ...entry.provider,
+        pluginId: entry.pluginId,
+      })),
+    );
+  }
+  return resolvePluginWebSearchProviders(params);
 }

src/web-search/runtime.test.ts

@@ -0,0 +1,46 @@
+import { afterEach, describe, expect, it } from "vitest";
+import { createEmptyPluginRegistry } from "../plugins/registry.js";
+import { setActivePluginRegistry } from "../plugins/runtime.js";
+import { runWebSearch } from "./runtime.js";
+
+describe("web search runtime", () => {
+  afterEach(() => {
+    setActivePluginRegistry(createEmptyPluginRegistry());
+  });
+
+  it("executes searches through the active plugin registry", async () => {
+    const registry = createEmptyPluginRegistry();
+    registry.webSearchProviders.push({
+      pluginId: "custom-search",
+      pluginName: "Custom Search",
+      provider: {
+        id: "custom",
+        label: "Custom Search",
+        hint: "Custom runtime provider",
+        envVars: ["CUSTOM_SEARCH_API_KEY"],
+        placeholder: "custom-...",
+        signupUrl: "https://example.com/signup",
+        autoDetectOrder: 1,
+        getCredentialValue: () => "configured",
+        setCredentialValue: () => {},
+        createTool: () => ({
+          description: "custom",
+          parameters: {},
+          execute: async (args) => ({ ...args, ok: true }),
+        }),
+      },
+      source: "test",
+    });
+    setActivePluginRegistry(registry);
+
+    await expect(
+      runWebSearch({
+        config: {},
+        args: { query: "hello" },
+      }),
+    ).resolves.toEqual({
+      provider: "custom",
+      result: { query: "hello", ok: true },
+    });
+  });
+});

src/web-search/runtime.ts

@@ -0,0 +1,194 @@
+import type { OpenClawConfig } from "../config/config.js";
+import { normalizeResolvedSecretInputString } from "../config/types.secrets.js";
+import { logVerbose } from "../globals.js";
+import type {
+  PluginWebSearchProviderEntry,
+  WebSearchProviderToolDefinition,
+} from "../plugins/types.js";
+import {
+  resolvePluginWebSearchProviders,
+  resolveRuntimeWebSearchProviders,
+} from "../plugins/web-search-providers.js";
+import type { RuntimeWebSearchMetadata } from "../secrets/runtime-web-tools.types.js";
+import { normalizeSecretInput } from "../utils/normalize-secret-input.js";
+
+type WebSearchConfig = NonNullable<OpenClawConfig["tools"]>["web"] extends infer Web
+  ? Web extends { search?: infer Search }
+    ? Search
+    : undefined
+  : undefined;
+
+export type ResolveWebSearchDefinitionParams = {
+  config?: OpenClawConfig;
+  sandboxed?: boolean;
+  runtimeWebSearch?: RuntimeWebSearchMetadata;
+  providerId?: string;
+  preferRuntimeProviders?: boolean;
+};
+
+export type RunWebSearchParams = ResolveWebSearchDefinitionParams & {
+  args: Record<string, unknown>;
+};
+
+function resolveSearchConfig(cfg?: OpenClawConfig): WebSearchConfig {
+  const search = cfg?.tools?.web?.search;
+  if (!search || typeof search !== "object") {
+    return undefined;
+  }
+  return search as WebSearchConfig;
+}
+
+export function resolveWebSearchEnabled(params: {
+  search?: WebSearchConfig;
+  sandboxed?: boolean;
+}): boolean {
+  if (typeof params.search?.enabled === "boolean") {
+    return params.search.enabled;
+  }
+  if (params.sandboxed) {
+    return true;
+  }
+  return true;
+}
+
+function readProviderEnvValue(envVars: string[]): string | undefined {
+  for (const envVar of envVars) {
+    const value = normalizeSecretInput(process.env[envVar]);
+    if (value) {
+      return value;
+    }
+  }
+  return undefined;
+}
+
+function hasProviderCredential(providerId: string, search: WebSearchConfig | undefined): boolean {
+  const providers = resolvePluginWebSearchProviders({
+    bundledAllowlistCompat: true,
+  });
+  const provider = providers.find((entry) => entry.id === providerId);
+  if (!provider) {
+    return false;
+  }
+  const rawValue = provider.getCredentialValue(search as Record<string, unknown> | undefined);
+  const fromConfig = normalizeSecretInput(
+    normalizeResolvedSecretInputString({
+      value: rawValue,
+      path:
+        providerId === "brave"
+          ? "tools.web.search.apiKey"
+          : `tools.web.search.${providerId}.apiKey`,
+    }),
+  );
+  return Boolean(fromConfig || readProviderEnvValue(provider.envVars));
+}
+
+export function listWebSearchProviders(params?: {
+  config?: OpenClawConfig;
+}): PluginWebSearchProviderEntry[] {
+  return resolveRuntimeWebSearchProviders({
+    config: params?.config,
+    bundledAllowlistCompat: true,
+  });
+}
+
+export function resolveWebSearchProviderId(params: {
+  search?: WebSearchConfig;
+  providers?: PluginWebSearchProviderEntry[];
+}): string {
+  const providers =
+    params.providers ??
+    resolvePluginWebSearchProviders({
+      bundledAllowlistCompat: true,
+    });
+  const raw =
+    params.search && "provider" in params.search && typeof params.search.provider === "string"
+      ? params.search.provider.trim().toLowerCase()
+      : "";
+
+  if (raw) {
+    const explicit = providers.find((provider) => provider.id === raw);
+    if (explicit) {
+      return explicit.id;
+    }
+  }
+
+  if (!raw) {
+    for (const provider of providers) {
+      if (!hasProviderCredential(provider.id, params.search)) {
+        continue;
+      }
+      logVerbose(
+        `web_search: no provider configured, auto-detected "${provider.id}" from available API keys`,
+      );
+      return provider.id;
+    }
+  }
+
+  return providers[0]?.id ?? "brave";
+}
+
+export function resolveWebSearchDefinition(
+  options?: ResolveWebSearchDefinitionParams,
+): { provider: PluginWebSearchProviderEntry; definition: WebSearchProviderToolDefinition } | null {
+  const search = resolveSearchConfig(options?.config);
+  if (!resolveWebSearchEnabled({ search, sandboxed: options?.sandboxed })) {
+    return null;
+  }
+
+  const providers = (
+    options?.preferRuntimeProviders
+      ? resolveRuntimeWebSearchProviders({
+          config: options?.config,
+          bundledAllowlistCompat: true,
+        })
+      : resolvePluginWebSearchProviders({
+          config: options?.config,
+          bundledAllowlistCompat: true,
+        })
+  ).filter(Boolean);
+  if (providers.length === 0) {
+    return null;
+  }
+
+  const providerId =
+    options?.providerId ??
+    options?.runtimeWebSearch?.selectedProvider ??
+    options?.runtimeWebSearch?.providerConfigured ??
+    resolveWebSearchProviderId({ search, providers });
+  const provider =
+    providers.find((entry) => entry.id === providerId) ??
+    providers.find((entry) => entry.id === resolveWebSearchProviderId({ search, providers })) ??
+    providers[0];
+  if (!provider) {
+    return null;
+  }
+
+  const definition = provider.createTool({
+    config: options?.config,
+    searchConfig: search as Record<string, unknown> | undefined,
+    runtimeMetadata: options?.runtimeWebSearch,
+  });
+  if (!definition) {
+    return null;
+  }
+
+  return { provider, definition };
+}
+
+export async function runWebSearch(
+  params: RunWebSearchParams,
+): Promise<{ provider: string; result: Record<string, unknown> }> {
+  const resolved = resolveWebSearchDefinition({ ...params, preferRuntimeProviders: true });
+  if (!resolved) {
+    throw new Error("web_search is disabled or no provider is available.");
+  }
+  return {
+    provider: resolved.provider.id,
+    result: await resolved.definition.execute(params.args),
+  };
+}
+
+export const __testing = {
+  resolveSearchConfig,
+  resolveWebSearchProviderId,
+};