mirror of
https://github.com/openclaw/openclaw.git
synced 2026-07-16 16:11:38 +00:00
d6b3950734
Keep the Tavily public artifact lightweight while lazily executing through the provider runtime. Verified with focused Tavily/provider artifact tests and clean CI.
47 lines
1.6 KiB
TypeScript
47 lines
1.6 KiB
TypeScript
// Tavily plugin module implements web search shared behavior.
|
|
import {
|
|
createWebSearchProviderContractFields,
|
|
type WebSearchProviderPlugin,
|
|
} from "openclaw/plugin-sdk/provider-web-search-contract";
|
|
|
|
export const TAVILY_CREDENTIAL_PATH = "plugins.entries.tavily.config.webSearch.apiKey";
|
|
|
|
export const TAVILY_GENERIC_SEARCH_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.";
|
|
|
|
export const TAVILY_GENERIC_SEARCH_SCHEMA = {
|
|
type: "object",
|
|
properties: {
|
|
query: { type: "string", description: "Search query string." },
|
|
count: {
|
|
type: "integer",
|
|
description: "Number of results to return (1-20).",
|
|
minimum: 1,
|
|
maximum: 20,
|
|
},
|
|
},
|
|
additionalProperties: false,
|
|
} satisfies Record<string, unknown>;
|
|
|
|
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",
|
|
}),
|
|
};
|
|
}
|