77 lines
2.7 KiB
TypeScript
77 lines
2.7 KiB
TypeScript
import { Type } from "@sinclair/typebox";
|
|
import {
|
|
enablePluginInConfig,
|
|
resolveProviderWebSearchPluginConfig,
|
|
setProviderWebSearchPluginConfigValue,
|
|
type WebSearchProviderPlugin,
|
|
} from "openclaw/plugin-sdk/provider-web-search";
|
|
import { runFirecrawlSearch } from "./firecrawl-client.js";
|
|
|
|
const GenericFirecrawlSearchSchema = Type.Object(
|
|
{
|
|
query: Type.String({ description: "Search query string." }),
|
|
count: Type.Optional(
|
|
Type.Number({
|
|
description: "Number of results to return (1-10).",
|
|
minimum: 1,
|
|
maximum: 10,
|
|
}),
|
|
),
|
|
},
|
|
{ additionalProperties: false },
|
|
);
|
|
|
|
function getScopedCredentialValue(searchConfig?: Record<string, unknown>): unknown {
|
|
const scoped = searchConfig?.firecrawl;
|
|
if (!scoped || typeof scoped !== "object" || Array.isArray(scoped)) {
|
|
return undefined;
|
|
}
|
|
return (scoped as Record<string, unknown>).apiKey;
|
|
}
|
|
|
|
function setScopedCredentialValue(
|
|
searchConfigTarget: Record<string, unknown>,
|
|
value: unknown,
|
|
): void {
|
|
const scoped = searchConfigTarget.firecrawl;
|
|
if (!scoped || typeof scoped !== "object" || Array.isArray(scoped)) {
|
|
searchConfigTarget.firecrawl = { apiKey: value };
|
|
return;
|
|
}
|
|
(scoped as Record<string, unknown>).apiKey = value;
|
|
}
|
|
|
|
export function createFirecrawlWebSearchProvider(): WebSearchProviderPlugin {
|
|
return {
|
|
id: "firecrawl",
|
|
label: "Firecrawl Search",
|
|
hint: "Structured results with optional result scraping",
|
|
envVars: ["FIRECRAWL_API_KEY"],
|
|
placeholder: "fc-...",
|
|
signupUrl: "https://www.firecrawl.dev/",
|
|
docsUrl: "https://docs.openclaw.ai/tools/firecrawl",
|
|
autoDetectOrder: 60,
|
|
credentialPath: "plugins.entries.firecrawl.config.webSearch.apiKey",
|
|
inactiveSecretPaths: ["plugins.entries.firecrawl.config.webSearch.apiKey"],
|
|
getCredentialValue: getScopedCredentialValue,
|
|
setCredentialValue: setScopedCredentialValue,
|
|
getConfiguredCredentialValue: (config) =>
|
|
resolveProviderWebSearchPluginConfig(config, "firecrawl")?.apiKey,
|
|
setConfiguredCredentialValue: (configTarget, value) => {
|
|
setProviderWebSearchPluginConfigValue(configTarget, "firecrawl", "apiKey", value);
|
|
},
|
|
applySelectionConfig: (config) => enablePluginInConfig(config, "firecrawl").config,
|
|
createTool: (ctx) => ({
|
|
description:
|
|
"Search the web using Firecrawl. Returns structured results with snippets from Firecrawl Search. Use firecrawl_search for Firecrawl-specific knobs like sources or categories.",
|
|
parameters: GenericFirecrawlSearchSchema,
|
|
execute: async (args) =>
|
|
await runFirecrawlSearch({
|
|
cfg: ctx.config,
|
|
query: typeof args.query === "string" ? args.query : "",
|
|
count: typeof args.count === "number" ? args.count : undefined,
|
|
}),
|
|
}),
|
|
};
|
|
}
|