Skip to content

Commit f9ee763

Browse files
committed
minor #950 [AI Bundle] Update tools registration documentation (OskarStark)
This PR was merged into the main branch. Discussion ---------- [AI Bundle] Update tools registration documentation | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Docs? | yes | Issues | -- | License | MIT Clarify that dedicated tool packages (Brave, Firecrawl, Mapbox, OpenMeteo, Tavily) are automatically configured via Flex recipes and require no manual setup. Only tools in the Toolbox\Tool namespace need manual service registration. Commits ------- f51f384 [AiBundle][Doc] Update tools registration documentation
2 parents d7cba24 + f51f384 commit f9ee763

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/bundles/ai-bundle.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -771,7 +771,17 @@ the :class:`Symfony\\AI\\AiBundle\\Attribute\\AsOutputProcessor` attributes::
771771
Register Tools
772772
~~~~~~~~~~~~~~
773773

774-
To use existing tools, you can register them as a service:
774+
The following tools can be installed as dedicated packages, no configuration is needed as these bridges come with flex recipes.
775+
776+
.. code-block:: terminal
777+
778+
$ composer require symfony/ai-brave-tool
779+
$ composer require symfony/ai-firecrawl-tool
780+
$ composer require symfony/ai-mapbox-tool
781+
$ composer require symfony/ai-openmeteo-tool
782+
$ composer require symfony/ai-tavily-tool
783+
784+
For tools not available as dedicated packages (those in the ``Toolbox\Tool`` namespace), register them manually as services:
775785

776786
.. code-block:: yaml
777787
@@ -781,19 +791,14 @@ To use existing tools, you can register them as a service:
781791
autoconfigure: true
782792
783793
Symfony\AI\Agent\Toolbox\Tool\Clock: ~
784-
Symfony\AI\Agent\Bridge\OpenMeteo\OpenMeteo: ~
785794
Symfony\AI\Agent\Toolbox\Tool\SerpApi:
786795
$apiKey: '%env(SERP_API_KEY)%'
787796
Symfony\AI\Agent\Toolbox\Tool\SimilaritySearch: ~
788797
Symfony\AI\Agent\Toolbox\Tool\Wikipedia: ~
789798
Symfony\AI\Agent\Toolbox\Tool\YouTubeTranscriber: ~
790-
Symfony\AI\Agent\Bridge\Firecrawl\Firecrawl:
791-
$endpoint: '%env(FIRECRAWL_ENDPOINT)%'
792-
$apiKey: '%env(FIRECRAWL_API_KEY)%'
793-
Symfony\AI\Agent\Bridge\Brave\Brave:
794-
$apiKey: '%env(BRAVE_API_KEY)%'
795-
Symfony\AI\Agent\Bridge\Tavily\Tavily:
796-
$apiKey: '%env(TAVILY_API_KEY)%'
799+
800+
Creating Custom Tools
801+
---------------------
797802

798803
Custom tools can be registered by using the :class:`Symfony\\AI\\Agent\\Toolbox\\Attribute\\AsTool` attribute::
799804

0 commit comments

Comments
 (0)