firecrawl-tool

1import { FirecrawlAppV1 as FirecrawlApp } from "@mendable/firecrawl-js";
2import { type InferUITool, tool } from "ai";
3import { z } from "zod";
4 
5const firecrawlParamsSchema = z.object({
6	mode: z
7		.enum(["search", "scrape"])
8		.describe(
9			"The operation to perform: 'search' for general queries, 'scrape' for a specific URL",
10		),
11	query: z
12		.string()
13		.describe("The search query or the specific URL to scrape"),
14});
15 
16export type FirecrawlParams = z.infer<typeof firecrawlParamsSchema>;
17 
18const firecrawlResultSchema = z.union([
19	z.object({
20		success: z.literal(true),
21		markdown: z.string(),
22	}),
23	z.object({
24		success: z.literal(true),
25		documents: z.array(z.any()),
26	}),
27	z.object({
28		success: z.literal(false),
29		error: z.string(),
30	}),
31]);
32 
33export type FirecrawlResult = z.infer<typeof firecrawlResultSchema>;
34 
35export const firecrawlTool = tool({
36	name: "firecrawl",
37	description:
38		"Search the web or scrape a specific URL using Firecrawl. Use this to find live information.",
39	inputSchema: firecrawlParamsSchema,
40	outputSchema: firecrawlResultSchema,
41	execute: async (params) => {
42		const apiKey = process.env.FIRECRAWL_API_KEY;
43 
44		if (!apiKey) {
45			return { success: false, error: "FIRECRAWL_API_KEY is not set" };
46		}
47 
48		try {
49			const app = new FirecrawlApp({ apiKey });
50 
51			if (params.mode === "scrape") {
52				const scrapeResult = await app.scrapeUrl(params.query, {
53					formats: ["markdown"],
54				});
55 
56				if (!scrapeResult.success) {
57					return {
58						success: false,
59						error: `Failed to scrape: ${scrapeResult.error || "Unknown error"}`,
60					};
61				}
62 
63				return { success: true, markdown: scrapeResult.markdown };
64			} else {
65				const searchResult = await app.search(params.query, {
66					limit: 3,
67					scrapeOptions: {
68						formats: ["markdown"],
69					},
70				});
71 
72				if (!searchResult.success) {
73					return {
74						success: false,
75						error: `Failed to search: ${searchResult.error || "Unknown error"}`,
76					};
77				}
78 
79				return { success: true, documents: searchResult.data };
80			}
81		} catch (error) {
82			return {
83				success: false,
84				error:
85					error instanceof Error
86						? error.message
87						: "Unknown error occurred",
88			};
89		}
90	},
91});
92 
93export type FirecrawlTool = InferUITool<typeof firecrawlTool>;