diff --git a/docs/features/plugin/tools/index.mdx b/docs/features/plugin/tools/index.mdx index db1a80c..f7c8e13 100644 --- a/docs/features/plugin/tools/index.mdx +++ b/docs/features/plugin/tools/index.mdx @@ -310,3 +310,30 @@ async def test_function( ) ``` + +## External packages + +In the Tools definition metadata you can specify custom packages. When you click `Save` the line will be parsed and `pip install` will be run on all requirements at once. + +Keep in mind that as pip is used in the same process as Open-WebUI, the UI will be completely unresponsive during the installation. + +No measures are taken to handle package conflicts with Open-WebUI's requirements. That means that specifying requirements can break OpenWebUI if you're not careful. You might be able to work around this by specifying `open-webui` itself as a requirement. + + +
+Example + +``` +""" +title: myToolName +author: myName +funding_url: [any link here will be shown behind a `Heart` button for users to show their support to you] +version: 1.0.0 +# the version is displayed in the UI to help users keep track of updates. +license: GPLv3 +description: [recommended] +requirements: package1>=2.7.0,package2,package3 +""" +``` + +