@@ -239,51 +239,38 @@ const CONFIG = {
239
239
240
240
---
241
241
242
- ## 📦 Available Tools & Use Cases
243
-
244
- | Tool Name | Best for | Returns |
245
- | ---------------------------| --------------------------------------| -------------------|
246
- | ` scrape ` | Single page content | markdown/html |
247
- | ` batch_scrape ` | Many known URLs | markdown/html[ ] |
248
- | ` map ` | Discovering URLs | URL[ ] |
249
- | ` crawl ` | Multi-page extraction | markdown/html[ ] |
250
- | ` search ` | Web search | results[ ] |
251
- | ` extract ` | Structured data | JSON |
252
- | ` deep_research ` | In-depth research | summary, sources |
253
- | ` generate_llmstxt ` | Create llms.txt for a site | text |
242
+ ## 📦 Available Tools Overview
243
+ - ** firecrawl_scrape** — Single page content extraction
244
+ - ** firecrawl_map** — URL discovery on websites
245
+ - ** firecrawl_crawl** — Multi-page extraction * (returns job ID)*
246
+ - ** firecrawl_check_crawl_status** — Monitor crawl progress
247
+ - ** firecrawl_search** — Web search with optional content scraping
248
+ - ** firecrawl_extract** — Structured data extraction to JSON
254
249
255
250
---
256
251
257
- ## 🔧 Example Usage
258
-
259
- ``` json
260
- {
261
- "name" : " firecrawl_scrape" ,
262
- "arguments" : {
263
- "url" : " https://example.com" ,
264
- "formats" : [" markdown" ],
265
- "onlyMainContent" : true ,
266
- "waitFor" : 1000 ,
267
- "timeout" : 30000 ,
268
- "mobile" : false ,
269
- "includeTags" : [" article" , " main" ],
270
- "excludeTags" : [" nav" , " footer" ],
271
- "skipTlsVerification" : false
272
- }
273
- }
274
- ```
252
+ ## 🔧 Key Usage Examples
253
+ The examples show proper parameter usage for common scenarios like:
254
+ - Basic page scraping with content filtering
255
+ - Web search with scraped results
256
+ - Structured data extraction with custom schemas
275
257
276
258
---
277
259
278
- ## 🔎 Choosing the Right Tool
260
+ ## 🔎 Decision Tree
261
+ Great guidance on tool selection based on needs:
262
+ - ** Known URL** → ` scrape `
263
+ - ** Find URLs** → ` map `
264
+ - ** Search web** → ` search `
265
+ - ** Extract structured data** → ` extract `
266
+ - ** Full site coverage** → ` crawl ` + ` status check `
267
+
268
+ ---
279
269
280
- - Know the exact URL?
281
- - Use ` scrape ` (single) or ` batch_scrape ` (multiple)
282
- - Need to find URLs on a site? → ` map `
283
- - Want to search the web? → ` search `
284
- - Want structured data? → ` extract `
285
- - Need full-site coverage? → ` crawl `
286
- - Need multi-source research? → ` deep_research `
270
+ # ⚡ Performance Optimization
271
+ Valuable tips:
272
+ - Use ` maxAge ` for caching
273
+ - Use ` onlyMainContent ` for efficiency
287
274
288
275
---
289
276
0 commit comments