Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://firecrawl-mog-search-exclude-include-domains.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Pré-requisitos

​
Instale o SDK

npm install @mendable/firecrawl-js

​
Defina sua chave de API

Adicione sua chave de API ao arquivo .env: 
FIRECRAWL_API_KEY=fc-YOUR-API-KEY

​
Crie as ferramentas do Firecrawl

Crie src/mastra/tools/firecrawl.ts para disponibilizar a busca e o scraping como ferramentas no Mastra: 
import Firecrawl from "@mendable/firecrawl-js";
import { createTool } from "@mastra/core/tools";
import { z } from "zod";

const firecrawl = new Firecrawl({ apiKey: process.env.FIRECRAWL_API_KEY! });

export const firecrawlSearch = createTool({
  id: "firecrawl-search",
  description: "Search the web and return top results.",
  inputSchema: z.object({ query: z.string().min(1) }),
  outputSchema: z.object({
    results: z.array(
      z.object({
        title: z.string().nullable(),
        url: z.string(),
      }),
    ),
  }),
  execute: async ({ query }) => {
    const results = await firecrawl.search(query, { limit: 3 });
    return {
      results: (results.web ?? []).map((item) => ({
        title: item.title ?? null,
        url: item.url,
      })),
    };
  },
});

export const firecrawlScrape = createTool({
  id: "firecrawl-scrape",
  description: "Scrape a URL and return markdown content.",
  inputSchema: z.object({ url: z.string().url() }),
  outputSchema: z.object({ markdown: z.string() }),
  execute: async ({ url }) => {
    const result = await firecrawl.scrape(url, {
      formats: ["markdown"],
      onlyMainContent: true,
    });
    return { markdown: result.markdown ?? "" };
  },
});

​
Crie o agente

Crie src/mastra/agents/web-agent.ts e adicione as ferramentas do Firecrawl a ele: 
import { Agent } from "@mastra/core/agent";
import { firecrawlSearch, firecrawlScrape } from "../tools/firecrawl";

export const webAgent = new Agent({
  id: "web-agent",
  name: "Web Agent",
  instructions:
    "Use Firecrawl tools to search and scrape web pages, then summarize the results.",
  model: "openai/gpt-5.4",
  tools: { firecrawlSearch, firecrawlScrape },
});

​
Registrar o agente

Registre o agente na sua instância do Mastra em src/mastra/index.ts: 
import { Mastra } from "@mastra/core";
import { webAgent } from "./agents/web-agent";

export const mastra = new Mastra({
  agents: { webAgent },
});

​
Teste no Studio

Inicie o servidor de desenvolvimento e abra o Mastra Studio: 
mastra dev
Abra o Web Agent e experimente prompts como:
  • “Encontre o changelog mais recente do Firecrawl e resuma a versão mais recente.”
  • “Pesquise os preços do Firecrawl e extraia as categorias de plano.”

​
Firecrawl self-hosted

Se você estiver executando o Firecrawl localmente, defina FIRECRAWL_API_URL e passe apiUrl para o cliente: 
const firecrawl = new Firecrawl({
  apiKey: process.env.FIRECRAWL_API_KEY!,
  apiUrl: process.env.FIRECRAWL_API_URL,
});

​
Próximos passos

Docs de scraping

Todas as opções de scraping, incluindo formatos, ações e proxies

Docs de busca

Faça uma busca na web e obtenha o conteúdo completo da página

Docs do agente

Deixe um agente conduzir o Firecrawl de ponta a ponta

Referência do SDK de Node

Referência completa do SDK com rastreamento, mapeamento, extração em lote e muito mais