Skip to content

Commit 0f30f03

Browse files
committed
Update toolbox package documentation with all available tools
Expand AGENTS.md and CLAUDE.md to include all third-party tools now housed in the toolbox package: - Brave Search: Web search functionality - Firecrawl: Website scraping, crawling, and mapping - Mapbox: Geocoding and reverse geocoding - OpenMeteo: Weather data and forecasting - SerpApi: Internet search via SerpApi - Tavily: Web search and content extraction - Wikipedia: Article search and retrieval - YouTube Transcriber: Video transcript fetching Includes API requirements, method descriptions, and integration notes.
1 parent efc9919 commit 0f30f03

File tree

2 files changed

+53
-6
lines changed

2 files changed

+53
-6
lines changed

src/toolbox/AGENTS.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,25 @@
55
This package provides third-party tools for AI agents including:
66

77
- **Brave Search**: Web search functionality using the Brave Search API
8+
- **Firecrawl**: Website scraping, crawling, and URL mapping capabilities
9+
- **Mapbox**: Geocoding and reverse geocoding services
10+
- **OpenMeteo**: Weather data and forecasting services
11+
- **SerpApi**: Internet search functionality via SerpApi
12+
- **Tavily**: Web search and content extraction services
813
- **Wikipedia**: Search and article retrieval from Wikipedia
14+
- **YouTube Transcriber**: Fetch transcripts from YouTube videos
915

1016
### Usage
1117

12-
These tools can be registered with AI agents to provide external data access capabilities.
18+
These tools can be registered with AI agents to provide external data access capabilities. Each tool is automatically configured with the `#[AsTool]` attribute for easy integration.
1319

1420
### Requirements
1521

1622
- PHP 8.2+
17-
- Brave Search API key (for Brave tool)
18-
- HTTP client implementation
23+
- Various API keys depending on tools used:
24+
- Brave Search API key (for Brave tool)
25+
- Mapbox access token (for Mapbox tool)
26+
- SerpApi key (for SerpApi tool)
27+
- Tavily API key (for Tavily tool)
28+
- HTTP client implementation
29+
- Optional: `mrmysql/youtube-transcript` package (for YouTube Transcriber)

src/toolbox/CLAUDE.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,42 @@ This package provides third-party tools for Symfony AI agents.
99
- Requires API key configuration
1010
- Returns formatted search results
1111

12+
### Firecrawl Tool
13+
- Website scraping with `firecrawl_scrape` method
14+
- Website crawling with `firecrawl_crawl` method
15+
- URL mapping with `firecrawl_map` method
16+
- Requires API key and endpoint configuration
17+
18+
### Mapbox Tool
19+
- Address geocoding with `geocode` method
20+
- Reverse geocoding with `reverse_geocode` method
21+
- Requires Mapbox access token
22+
23+
### OpenMeteo Tool
24+
- Current weather data with `weather_current` method
25+
- Weather forecasting with `weather_forecast` method
26+
- No API key required (public API)
27+
28+
### SerpApi Tool
29+
- Internet search functionality via SerpApi
30+
- Requires SerpApi key configuration
31+
- Returns search result titles
32+
33+
### Tavily Tool
34+
- Web search with `tavily_search` method
35+
- Content extraction with `tavily_extract` method
36+
- Requires Tavily API key
37+
1238
### Wikipedia Tool
13-
- Searches Wikipedia articles
14-
- Retrieves full article content
39+
- Searches Wikipedia articles with `wikipedia_search` method
40+
- Retrieves full article content with `wikipedia_article` method
1541
- Supports multiple languages
42+
- No API key required
43+
44+
### YouTube Transcriber Tool
45+
- Fetches transcripts from YouTube videos
46+
- Requires `mrmysql/youtube-transcript` package
47+
- No API key required
1648

1749
## Development
1850

@@ -24,4 +56,8 @@ vendor/bin/phpunit
2456
Run static analysis:
2557
```bash
2658
vendor/bin/phpstan analyse
27-
```
59+
```
60+
61+
## Tool Integration
62+
63+
All tools are automatically configured with the `#[AsTool]` attribute and can be easily integrated into AI agents using the agent framework.

0 commit comments

Comments
 (0)