khanh.pndc/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2025-12-12 07:29:49 +07:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add warning about tool package version conflicts

Browse Source 
Adds a prominent warning to the tool development documentation regarding the potential for package version conflicts when multiple tools are installed with conflicting dependencies.

The warning recommends using OpenAPI tool servers as the robust solution to this problem, as it isolates tool dependencies.
This commit is contained in:
silentoplayz
2025-11-18 22:10:55 -05:00
parent 22531b9a24
commit 7b723ceede
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/features/plugin/tools/development.mdx
View File

@@ -1627,6 +1627,18 @@ More info about the header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Re
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. 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.
:::warning
**🚨 CRITICAL WARNING: Potential for Package Version Conflicts**
When multiple tools define different versions of the same package (e.g., Tool A requires `pandas==1.5.0` and Tool B requires `pandas==2.0.0`), Open WebUI installs them in a non-deterministic order. This can lead to unpredictable behavior and break one or more of your tools.
**The only robust solution to this problem is to use an OpenAPI tool server.**
We strongly recommend using an [OpenAPI tool server](/features/plugin/tools/openapi-servers/) to avoid these dependency conflicts.
:::
Keep in mind that as pip is used in the same process as Open WebUI, the UI will be completely unresponsive during the installation. 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 Open WebUI if you're not careful. You might be able to work around this by specifying `open-webui` itself as a requirement. No measures are taken to handle package conflicts with Open WebUI's requirements. That means that specifying requirements can break Open WebUI if you're not careful. You might be able to work around this by specifying `open-webui` itself as a requirement.