firecrawl_scrape

Instructions

{
  "name": "firecrawl_scrape",
  "arguments": {
    "url": "https://example.com",
    "formats": ["markdown"],
    "maxAge": 172800000
  }
}

Implementation Reference

• src/index.ts:293-309 (handler)

  Handler function that executes the firecrawl_scrape tool. It extracts the URL and options, cleans the options, gets the Firecrawl client, calls client.scrape, and returns the result as JSON string.

  execute: async (
    args: unknown,
    { session, log }: { session?: SessionData; log: Logger }
  ): Promise<string> => {
    const { url, ...options } = args as { url: string } & Record<
      string,
      unknown
    >;
    const client = getClient(session);
    const cleaned = removeEmptyTopLevel(options as Record<string, unknown>);
    log.info('Scraping URL', { url: String(url) });
    const res = await client.scrape(String(url), {
      ...cleaned,
      origin: ORIGIN,
    } as any);
    return asText(res);
  },

• src/index.ts:185-260 (schema)

  Zod schema defining the input parameters for the firecrawl_scrape tool (shared with other scrape-related tools).

  const scrapeParamsSchema = z.object({
    url: z.string().url(),
    formats: z
      .array(
        z.union([
          z.enum([
            'markdown',
            'html',
            'rawHtml',
            'screenshot',
            'links',
            'summary',
            'changeTracking',
            'branding',
          ]),
          z.object({
            type: z.literal('json'),
            prompt: z.string().optional(),
            schema: z.record(z.string(), z.any()).optional(),
          }),
          z.object({
            type: z.literal('screenshot'),
            fullPage: z.boolean().optional(),
            quality: z.number().optional(),
            viewport: z
              .object({ width: z.number(), height: z.number() })
              .optional(),
          }),
        ])
      )
      .optional(),
    parsers: z
      .array(
        z.union([
          z.enum(['pdf']),
          z.object({
            type: z.enum(['pdf']),
            maxPages: z.number().int().min(1).max(10000).optional(),
          }),
        ])
      )
      .optional(),
    onlyMainContent: z.boolean().optional(),
    includeTags: z.array(z.string()).optional(),
    excludeTags: z.array(z.string()).optional(),
    waitFor: z.number().optional(),
    ...(SAFE_MODE
      ? {}
      : {
          actions: z
            .array(
              z.object({
                type: z.enum(allowedActionTypes),
                selector: z.string().optional(),
                milliseconds: z.number().optional(),
                text: z.string().optional(),
                key: z.string().optional(),
                direction: z.enum(['up', 'down']).optional(),
                script: z.string().optional(),
                fullPage: z.boolean().optional(),
              })
            )
            .optional(),
        }),
    mobile: z.boolean().optional(),
    skipTlsVerification: z.boolean().optional(),
    removeBase64Images: z.boolean().optional(),
    location: z
      .object({
        country: z.string().optional(),
        languages: z.array(z.string()).optional(),
      })
      .optional(),
    storeInCache: z.boolean().optional(),
    maxAge: z.number().optional(),
  });

• src/index.ts:262-310 (registration)

  Registration of the 'firecrawl_scrape' tool on the FastMCP server, specifying name, description, input schema, and handler function.

  server.addTool({
    name: 'firecrawl_scrape',
    description: `
  Scrape content from a single URL with advanced options. 
  This is the most powerful, fastest and most reliable scraper tool, if available you should always default to using this tool for any web scraping needs.
  
  **Best for:** Single page content extraction, when you know exactly which page contains the information.
  **Not recommended for:** Multiple pages (use batch_scrape), unknown page (use search), structured data (use extract).
  **Common mistakes:** Using scrape for a list of URLs (use batch_scrape instead). If batch scrape doesnt work, just use scrape and call it multiple times.
  **Other Features:** Use 'branding' format to extract brand identity (colors, fonts, typography, spacing, UI components) for design analysis or style replication.
  **Prompt Example:** "Get the content of the page at https://example.com."
  **Usage Example:**
  \`\`\`json
  {
    "name": "firecrawl_scrape",
    "arguments": {
      "url": "https://example.com",
      "formats": ["markdown"],
      "maxAge": 172800000
    }
  }
  \`\`\`
  **Performance:** Add maxAge parameter for 500% faster scrapes using cached data.
  **Returns:** Markdown, HTML, or other formats as specified.
  ${
    SAFE_MODE
      ? '**Safe Mode:** Read-only content extraction. Interactive actions (click, write, executeJavascript) are disabled for security.'
      : ''
  }
  `,
    parameters: scrapeParamsSchema,
    execute: async (
      args: unknown,
      { session, log }: { session?: SessionData; log: Logger }
    ): Promise<string> => {
      const { url, ...options } = args as { url: string } & Record<
        string,
        unknown
      >;
      const client = getClient(session);
      const cleaned = removeEmptyTopLevel(options as Record<string, unknown>);
      log.info('Scraping URL', { url: String(url) });
      const res = await client.scrape(String(url), {
        ...cleaned,
        origin: ORIGIN,
      } as any);
      return asText(res);
    },
  });