[Agent][Firecrawl] Add symfony/ai-firecrawl-tool

OskarStark · OskarStark · commit 9e4e65fca719 · 2025-11-22T22:49:46.000+01:00
Extract Firecrawl tool to a dedicated bridge following the same pattern
as Tavily and Brave bridges. This creates a new package symfony/ai-firecrawl-tool
with its own composer.json, tests, and dependencies.

Changes:
- Move Firecrawl.php to src/agent/src/Bridge/Firecrawl/
- Update namespace from Symfony\AI\Agent\Toolbox\Tool to Symfony\AI\Agent\Bridge\Firecrawl
- Move tests and fixtures to bridge directory
- Create dedicated composer.json for the bridge
- Update examples to use new namespace
- Update documentation with new namespace
diff --git a/docs/bundles/ai-bundle.rst b/docs/bundles/ai-bundle.rst
@@ -787,7 +787,7 @@ To use existing tools, you can register them as a service:
         Symfony\AI\Agent\Toolbox\Tool\SimilaritySearch: ~
         Symfony\AI\Agent\Toolbox\Tool\Wikipedia: ~
         Symfony\AI\Agent\Toolbox\Tool\YouTubeTranscriber: ~
-        Symfony\AI\Agent\Toolbox\Tool\Firecrawl:
+        Symfony\AI\Agent\Bridge\Firecrawl\Firecrawl:
           $endpoint: '%env(FIRECRAWL_ENDPOINT)%'
           $apiKey: '%env(FIRECRAWL_API_KEY)%'
         Symfony\AI\Agent\Bridge\Brave\Brave:
diff --git a/examples/toolbox/firecrawl-crawl.php b/examples/toolbox/firecrawl-crawl.php
@@ -10,8 +10,8 @@
  */
 
 use Symfony\AI\Agent\Agent;
+use Symfony\AI\Agent\Bridge\Firecrawl\Firecrawl;
 use Symfony\AI\Agent\Toolbox\AgentProcessor;
-use Symfony\AI\Agent\Toolbox\Tool\Firecrawl;
 use Symfony\AI\Agent\Toolbox\Toolbox;
 use Symfony\AI\Platform\Bridge\OpenAi\PlatformFactory;
 use Symfony\AI\Platform\Message\Message;
diff --git a/examples/toolbox/firecrawl-map.php b/examples/toolbox/firecrawl-map.php
@@ -10,8 +10,8 @@
  */
 
 use Symfony\AI\Agent\Agent;
+use Symfony\AI\Agent\Bridge\Firecrawl\Firecrawl;
 use Symfony\AI\Agent\Toolbox\AgentProcessor;
-use Symfony\AI\Agent\Toolbox\Tool\Firecrawl;
 use Symfony\AI\Agent\Toolbox\Toolbox;
 use Symfony\AI\Platform\Bridge\OpenAi\PlatformFactory;
 use Symfony\AI\Platform\Message\Message;
diff --git a/examples/toolbox/firecrawl-scrape.php b/examples/toolbox/firecrawl-scrape.php
@@ -10,8 +10,8 @@
  */
 
 use Symfony\AI\Agent\Agent;
+use Symfony\AI\Agent\Bridge\Firecrawl\Firecrawl;
 use Symfony\AI\Agent\Toolbox\AgentProcessor;
-use Symfony\AI\Agent\Toolbox\Tool\Firecrawl;
 use Symfony\AI\Agent\Toolbox\Toolbox;
 use Symfony\AI\Platform\Bridge\OpenAi\PlatformFactory;
 use Symfony\AI\Platform\Message\Message;
diff --git a/src/agent/src/Bridge/Firecrawl/.gitattributes b/src/agent/src/Bridge/Firecrawl/.gitattributes
@@ -0,0 +1,3 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.git* export-ignore
diff --git a/src/agent/src/Bridge/Firecrawl/.github/PULL_REQUEST_TEMPLATE.md b/src/agent/src/Bridge/Firecrawl/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,8 @@
+Please do not submit any Pull Requests here. They will be closed.
+---
+
+Please submit your PR here instead:
+https://github.com/symfony/ai
+
+This repository is what we call a "subtree split": a read-only subset of that main repository.
+We're looking forward to your PR there!
diff --git a/src/agent/src/Bridge/Firecrawl/.github/close-pull-request.yml b/src/agent/src/Bridge/Firecrawl/.github/close-pull-request.yml
@@ -0,0 +1,20 @@
+name: Close Pull Request
+
+on:
+  pull_request_target:
+    types: [opened]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: superbrothers/close-pull-request@v3
+      with:
+        comment: |
+          Thanks for your Pull Request! We love contributions.
+
+          However, you should instead open your PR on the main repository:
+          https://github.com/symfony/ai
+
+          This repository is what we call a "subtree split": a read-only subset of that main repository.
+          We're looking forward to your PR there!
diff --git a/src/agent/src/Bridge/Firecrawl/.gitignore b/src/agent/src/Bridge/Firecrawl/.gitignore
@@ -0,0 +1,4 @@
+vendor/
+composer.lock
+phpunit.xml
+.phpunit.result.cache
diff --git a/src/agent/src/Bridge/Firecrawl/CHANGELOG.md b/src/agent/src/Bridge/Firecrawl/CHANGELOG.md
@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+0.1
+---
+
+ * Add the bridge
diff --git a/src/agent/src/Bridge/Firecrawl/Firecrawl.php b/src/agent/src/Bridge/Firecrawl/Firecrawl.php
@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\AI\Agent\Toolbox\Tool;
+namespace Symfony\AI\Agent\Bridge\Firecrawl;
 
 use Symfony\AI\Agent\Toolbox\Attribute\AsTool;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
diff --git a/src/agent/src/Bridge/Firecrawl/LICENSE b/src/agent/src/Bridge/Firecrawl/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2025-present Fabien Potencier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/src/agent/src/Bridge/Firecrawl/Tests/FirecrawlTest.php b/src/agent/src/Bridge/Firecrawl/Tests/FirecrawlTest.php
@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\AI\Agent\Bridge\Firecrawl\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\AI\Agent\Bridge\Firecrawl\Firecrawl;
+use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\JsonMockResponse;
+
+final class FirecrawlTest extends TestCase
+{
+    public function testScrape()
+    {
+        $httpClient = new MockHttpClient([
+            JsonMockResponse::fromFile(__DIR__.'/fixtures/firecrawl-scrape.json'),
+        ]);
+
+        $firecrawl = new Firecrawl($httpClient, 'test', 'https://127.0.0.1:3002');
+
+        $scrapingResult = $firecrawl->scrape('https://www.symfony.com');
+
+        self::assertSame('https://www.symfony.com', $scrapingResult['url']);
+        self::assertNotEmpty($scrapingResult['markdown']);
+        self::assertNotEmpty($scrapingResult['html']);
+        self::assertSame(1, $httpClient->getRequestsCount());
+    }
+
+    public function testCrawl()
+    {
+        $httpClient = new MockHttpClient([
+            JsonMockResponse::fromFile(__DIR__.'/fixtures/firecrawl-crawl-wait.json'),
+            JsonMockResponse::fromFile(__DIR__.'/fixtures/firecrawl-crawl-status.json'),
+            JsonMockResponse::fromFile(__DIR__.'/fixtures/firecrawl-crawl-status-done.json'),
+            JsonMockResponse::fromFile(__DIR__.'/fixtures/firecrawl-crawl.json'),
+        ]);
+
+        $firecrawl = new Firecrawl($httpClient, 'test', 'https://127.0.0.1:3002');
+
+        $scrapingResult = $firecrawl->crawl('https://www.symfony.com');
+
+        self::assertCount(1, $scrapingResult);
+        self::assertNotEmpty($scrapingResult[0]);
+
+        $firstItem = $scrapingResult[0];
+        self::assertSame('https://www.symfony.com', $firstItem['url']);
+        self::assertNotEmpty($firstItem['markdown']);
+        self::assertNotEmpty($firstItem['html']);
+        self::assertSame(4, $httpClient->getRequestsCount());
+    }
+
+    public function testMap()
+    {
+        $httpClient = new MockHttpClient([
+            JsonMockResponse::fromFile(__DIR__.'/fixtures/firecrawl-map.json'),
+        ]);
+
+        $firecrawl = new Firecrawl($httpClient, 'test', 'https://127.0.0.1:3002');
+
+        $mapping = $firecrawl->map('https://www.symfony.com');
+
+        self::assertSame('https://www.symfony.com', $mapping['url']);
+        self::assertCount(5, $mapping['links']);
+        self::assertSame(1, $httpClient->getRequestsCount());
+    }
+}
diff --git a/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-crawl-status-done.json b/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-crawl-status-done.json
diff --git a/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-crawl-status.json b/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-crawl-status.json
diff --git a/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-crawl-wait.json b/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-crawl-wait.json
diff --git a/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-crawl.json b/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-crawl.json
diff --git a/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-map.json b/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-map.json
diff --git a/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-scrape.json b/src/agent/src/Bridge/Firecrawl/Tests/fixtures/firecrawl-scrape.json
diff --git a/src/agent/src/Bridge/Firecrawl/composer.json b/src/agent/src/Bridge/Firecrawl/composer.json
@@ -0,0 +1,45 @@
+{
+    "name": "symfony/ai-firecrawl-tool",
+    "description": "Firecrawl AI tool bridge for Symfony applications.",
+    "license": "MIT",
+    "type": "library",
+    "keywords": ["ai", "bridge", "firecrawl", "agent", "tool"],
+    "authors": [
+        {
+            "name": "Guillaume Loulier",
+            "email": "personal@guillaumeloulier.fr"
+        },
+        {
+            "name": "Oskar Stark",
+            "email": "oskarstark@googlemail.com"
+        }
+    ],
+    "require": {
+        "php": ">=8.2",
+        "symfony/ai-agent": "@dev",
+        "symfony/http-client": "^7.3|^8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^11.5.13"
+    },
+    "autoload": {
+        "psr-4": {
+            "Symfony\\AI\\Agent\\Bridge\\Firecrawl\\": ""
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Symfony\\AI\\Agent\\Bridge\\Firecrawl\\Tests\\": "Tests/"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "thanks": {
+            "name": "symfony/ai",
+            "url": "https://github.com/symfony/ai"
+        }
+    },
+    "minimum-stability": "dev"
+}
diff --git a/src/agent/src/Bridge/Firecrawl/phpunit.xml.dist b/src/agent/src/Bridge/Firecrawl/phpunit.xml.dist
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.3/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+         failOnDeprecation="true"
+         failOnRisky="true"
+         failOnWarning="true"
+>
+    <php>
+        <ini name="error_reporting" value="-1" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Symfony AI Firecrawl Tool Test Suite">
+            <directory>./Tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <source ignoreSuppressionOfDeprecations="true">
+        <include>
+            <directory>./</directory>
+        </include>
+        <exclude>
+            <directory>./Resources</directory>
+            <directory>./Tests</directory>
+            <directory>./vendor</directory>
+        </exclude>
+    </source>
+</phpunit>
diff --git a/src/agent/tests/Toolbox/Tool/FirecrawlTest.php b/src/agent/tests/Toolbox/Tool/FirecrawlTest.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+/Tests export-ignore`
	`2`	`+/phpunit.xml.dist export-ignore`
	`3`	`+/.git* export-ignore`