refactor: share tavily web search helpers

This commit is contained in:
Vincent Koc
2026-05-29 08:05:11 +02:00
parent 08beb6b0e8
commit 05ff7d374f
6 changed files with 51 additions and 74 deletions

View File

@@ -1,5 +1,3 @@
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-contracts";
import type { OpenClawPluginToolContext } from "openclaw/plugin-sdk/plugin-entry";
import type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-runtime";
import {
jsonResult,
@@ -8,20 +6,9 @@ import {
} from "openclaw/plugin-sdk/provider-web-search";
import { Type } from "typebox";
import { runTavilyExtract } from "./tavily-client.js";
import { resolveTavilyToolConfig, type TavilyToolConfigContext } from "./tavily-tool-config.js";
import { optionalStringEnum } from "./tavily-tool-schema.js";
type TavilyToolConfigContext = Pick<
OpenClawPluginToolContext,
"config" | "runtimeConfig" | "getRuntimeConfig"
>;
function resolveTavilyToolConfig(
api: OpenClawPluginApi,
ctx?: TavilyToolConfigContext,
): OpenClawConfig {
return ctx?.getRuntimeConfig?.() ?? ctx?.runtimeConfig ?? ctx?.config ?? api.config;
}
const TavilyExtractToolSchema = Type.Object(
{
urls: Type.Array(Type.String(), {

View File

@@ -1,10 +1,6 @@
import { readPositiveIntegerParam } from "openclaw/plugin-sdk/param-readers";
import {
createWebSearchProviderContractFields,
type WebSearchProviderPlugin,
} from "openclaw/plugin-sdk/provider-web-search-contract";
const TAVILY_CREDENTIAL_PATH = "plugins.entries.tavily.config.webSearch.apiKey";
import { type WebSearchProviderPlugin } from "openclaw/plugin-sdk/provider-web-search-contract";
import { buildTavilyWebSearchProviderBase } from "../web-search-shared.js";
type TavilyClientModule = typeof import("./tavily-client.js");
@@ -31,23 +27,7 @@ const GenericTavilySearchSchema = {
export function createTavilyWebSearchProvider(): WebSearchProviderPlugin {
return {
id: "tavily",
label: "Tavily Search",
hint: "Structured results with domain filters and AI answer summaries",
onboardingScopes: ["text-inference"],
credentialLabel: "Tavily API key",
envVars: ["TAVILY_API_KEY"],
placeholder: "tvly-...",
signupUrl: "https://tavily.com/",
docsUrl: "https://docs.openclaw.ai/tools/tavily",
autoDetectOrder: 70,
credentialPath: TAVILY_CREDENTIAL_PATH,
...createWebSearchProviderContractFields({
credentialPath: TAVILY_CREDENTIAL_PATH,
searchCredential: { type: "scoped", scopeId: "tavily" },
configuredCredential: { pluginId: "tavily" },
selectionPluginId: "tavily",
}),
...buildTavilyWebSearchProviderBase(),
createTool: (ctx) => ({
description:
"Search the web using Tavily. Returns structured results with snippets. Use tavily_search for Tavily-specific options like search depth, topic filtering, or AI answers.",

View File

@@ -1,5 +1,3 @@
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-contracts";
import type { OpenClawPluginToolContext } from "openclaw/plugin-sdk/plugin-entry";
import type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-runtime";
import {
jsonResult,
@@ -8,20 +6,9 @@ import {
} from "openclaw/plugin-sdk/provider-web-search";
import { Type } from "typebox";
import { runTavilySearch } from "./tavily-client.js";
import { resolveTavilyToolConfig, type TavilyToolConfigContext } from "./tavily-tool-config.js";
import { optionalStringEnum } from "./tavily-tool-schema.js";
type TavilyToolConfigContext = Pick<
OpenClawPluginToolContext,
"config" | "runtimeConfig" | "getRuntimeConfig"
>;
function resolveTavilyToolConfig(
api: OpenClawPluginApi,
ctx?: TavilyToolConfigContext,
): OpenClawConfig {
return ctx?.getRuntimeConfig?.() ?? ctx?.runtimeConfig ?? ctx?.config ?? api.config;
}
const TavilySearchToolSchema = Type.Object(
{
query: Type.String({ description: "Search query string." }),

View File

@@ -0,0 +1,15 @@
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-contracts";
import type { OpenClawPluginToolContext } from "openclaw/plugin-sdk/plugin-entry";
import type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-runtime";
export type TavilyToolConfigContext = Pick<
OpenClawPluginToolContext,
"config" | "runtimeConfig" | "getRuntimeConfig"
>;
export function resolveTavilyToolConfig(
api: OpenClawPluginApi,
ctx?: TavilyToolConfigContext,
): OpenClawConfig {
return ctx?.getRuntimeConfig?.() ?? ctx?.runtimeConfig ?? ctx?.config ?? api.config;
}

View File

@@ -1,29 +1,9 @@
import {
createWebSearchProviderContractFields,
type WebSearchProviderPlugin,
} from "openclaw/plugin-sdk/provider-web-search-contract";
import { type WebSearchProviderPlugin } from "openclaw/plugin-sdk/provider-web-search-contract";
import { buildTavilyWebSearchProviderBase } from "./web-search-shared.js";
export function createTavilyWebSearchProvider(): WebSearchProviderPlugin {
const credentialPath = "plugins.entries.tavily.config.webSearch.apiKey";
return {
id: "tavily",
label: "Tavily Search",
hint: "Structured results with domain filters and AI answer summaries",
onboardingScopes: ["text-inference"],
credentialLabel: "Tavily API key",
envVars: ["TAVILY_API_KEY"],
placeholder: "tvly-...",
signupUrl: "https://tavily.com/",
docsUrl: "https://docs.openclaw.ai/tools/tavily",
autoDetectOrder: 70,
credentialPath,
...createWebSearchProviderContractFields({
credentialPath,
searchCredential: { type: "scoped", scopeId: "tavily" },
configuredCredential: { pluginId: "tavily" },
selectionPluginId: "tavily",
}),
...buildTavilyWebSearchProviderBase(),
createTool: () => null,
};
}

View File

@@ -0,0 +1,28 @@
import {
createWebSearchProviderContractFields,
type WebSearchProviderPlugin,
} from "openclaw/plugin-sdk/provider-web-search-contract";
export const TAVILY_CREDENTIAL_PATH = "plugins.entries.tavily.config.webSearch.apiKey";
export function buildTavilyWebSearchProviderBase(): Omit<WebSearchProviderPlugin, "createTool"> {
return {
id: "tavily",
label: "Tavily Search",
hint: "Structured results with domain filters and AI answer summaries",
onboardingScopes: ["text-inference"],
credentialLabel: "Tavily API key",
envVars: ["TAVILY_API_KEY"],
placeholder: "tvly-...",
signupUrl: "https://tavily.com/",
docsUrl: "https://docs.openclaw.ai/tools/tavily",
autoDetectOrder: 70,
credentialPath: TAVILY_CREDENTIAL_PATH,
...createWebSearchProviderContractFields({
credentialPath: TAVILY_CREDENTIAL_PATH,
searchCredential: { type: "scoped", scopeId: "tavily" },
configuredCredential: { pluginId: "tavily" },
selectionPluginId: "tavily",
}),
};
}