Skip to content
This repository was archived by the owner on Nov 10, 2025. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crewai_tools/tools/firecrawl_scrape_website_tool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,23 @@ Utilize the FirecrawlScrapeWebsiteTool as follows to allow your agent to load we
```python
from crewai_tools import FirecrawlScrapeWebsiteTool

# Method 1: Pass URL when running the tool
tool = FirecrawlScrapeWebsiteTool(config={"formats": ['html']})
tool.run(url="firecrawl.dev")

# Method 2: Pass URL when creating the tool
tool = FirecrawlScrapeWebsiteTool(url="firecrawl.dev")
tool.run()

# Method 3: Pass URL in both places (URL in run method takes precedence)
tool = FirecrawlScrapeWebsiteTool(url="firecrawl.dev")
tool.run(url="different-site.com") # This will scrape different-site.com
```

## Arguments

- `api_key`: Optional. Specifies Firecrawl API key. Defaults is the `FIRECRAWL_API_KEY` environment variable.
- `url`: Optional. The URL to scrape. Can be provided when creating the tool or when calling run().
- `config`: Optional. It contains Firecrawl API parameters.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ class FirecrawlScrapeWebsiteTool(BaseTool):
Args:
api_key (str): Your Firecrawl API key.
config (dict): Optional. It contains Firecrawl API parameters.
url (str): Optional. The URL to scrape. Can also be provided when calling run().

Default configuration options:
formats (list[str]): Content formats to return. Default: ["markdown"]
Expand Down Expand Up @@ -46,11 +47,14 @@ class FirecrawlScrapeWebsiteTool(BaseTool):
"wait_for": 0,
}
)
url: Optional[str] = None

_firecrawl: Optional["FirecrawlApp"] = PrivateAttr(None)

def __init__(self, api_key: Optional[str] = None, **kwargs):
super().__init__(**kwargs)
def __init__(self, api_key: Optional[str] = None, url: Optional[str] = None, **kwargs):
if url is not None:
kwargs["url"] = url
super().__init__(api_key=api_key, **kwargs)
try:
from firecrawl import FirecrawlApp # type: ignore
except ImportError:
Expand All @@ -72,8 +76,11 @@ def __init__(self, api_key: Optional[str] = None, **kwargs):

self._firecrawl = FirecrawlApp(api_key=api_key)

def _run(self, url: str):
return self._firecrawl.scrape_url(url, **self.config)
def _run(self, url: Optional[str] = None, **kwargs):
url_to_use = url if url is not None else self.url
if url_to_use is None:
raise ValueError("URL must be provided either in constructor or run method")
return self._firecrawl.scrape_url(url_to_use, **self.config)


try:
Expand Down
55 changes: 55 additions & 0 deletions tests/tools/firecrawl_scrape_website_tool/test_issue_2783_fixed.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import unittest
import sys
from unittest.mock import MagicMock, patch

mock_firecrawl = MagicMock()
mock_firecrawl_app = MagicMock()
mock_firecrawl.FirecrawlApp = mock_firecrawl_app
sys.modules['firecrawl'] = mock_firecrawl

from crewai_tools import FirecrawlScrapeWebsiteTool


class TestIssue2783(unittest.TestCase):
def setUp(self):
self.mock_instance = MagicMock()
self.mock_instance.scrape_url.return_value = "mocked response"
mock_firecrawl_app.return_value = self.mock_instance

def test_run_with_url_parameter(self):
tool = FirecrawlScrapeWebsiteTool(api_key="test_key")
result = tool.run(url="example.com")

self.mock_instance.scrape_url.assert_called_once()
args, kwargs = self.mock_instance.scrape_url.call_args
self.assertEqual(len(args), 1) # Only one positional argument (url)
self.assertEqual(args[0], "example.com")
self.assertEqual(result, "mocked response")

def test_init_with_url_parameter(self):
tool = FirecrawlScrapeWebsiteTool(api_key="test_key", url="example.com")

result = tool.run()

self.mock_instance.scrape_url.assert_called_once()
args, kwargs = self.mock_instance.scrape_url.call_args
self.assertEqual(len(args), 1) # Only one positional argument (url)
self.assertEqual(args[0], "example.com")
self.assertEqual(result, "mocked response")

def test_init_and_run_with_url_parameter(self):
tool = FirecrawlScrapeWebsiteTool(api_key="test_key", url="example.com")

result = tool.run(url="different-example.com")

self.mock_instance.scrape_url.assert_called_once()
args, kwargs = self.mock_instance.scrape_url.call_args
self.assertEqual(len(args), 1) # Only one positional argument (url)
self.assertEqual(args[0], "different-example.com")
self.assertEqual(result, "mocked response")

def test_no_url_parameter(self):
tool = FirecrawlScrapeWebsiteTool(api_key="test_key")

with self.assertRaises(ValueError):
tool.run()
Loading