跳到主要内容

🔗 开放式 WebUI 集成

概述​

开放式 WebUI v0.6+ 支持通过 OpenAPI 服务器与外部工具无缝集成——这意味着您可以通过自定义或社区支持的工具服务器轻松扩展您的 LLM 工作流 🧰。

在本指南中，您将学习如何启动一个兼容 OpenAPI 的工具服务器，并通过直观的用户界面将其连接到开放式 WebUI。让我们开始吧！ 🚀

第一步：启动 OpenAPI 工具服务器​

首先，您需要启动 openapi-servers 仓库中可用的参考工具服务器之一。为了快速测试，我们将以时间工具服务器为例。

🛠️ 示例：本地启动 time 工具服务器

git clone https://github.com/open-webui/openapi-servers
cd openapi-servers

# 进入时间工具服务器目录
cd servers/time

# 安装必要的依赖项
pip install -r requirements.txt

# 启动服务器
uvicorn main:app --host 0.0.0.0 --reload

运行后，此操作将在 http://localhost:8000 上托管一个本地 OpenAPI 服务器，您可以将其指向开放式 WebUI。

时间工具服务器

第二步：在开放式 WebUI 中连接工具服务器​

接下来，将运行中的工具服务器连接到开放式 WebUI：

  1. 在浏览器中打开开放式 WebUI。
  2. 打开 ⚙️ 设置。
  3. 单击 ➕ 工具 以添加新的工具服务器。
  4. 输入您的 OpenAPI 工具服务器运行的 URL（例如 http://localhost:8000）。
  5. 点击 "保存"。

设置页面

🧑‍💻 用户工具服务器 vs. 🛠️ 全局工具服务器​

在开放式 WebUI 中注册工具服务器的两种方式：

1. 用户工具服务器（通过常规设置添加）​

  • 仅供注册该工具服务器的用户访问。
  • 由用户通过浏览器（客户端）直接连接。
  • 非常适合个人工作流或测试自定义/本地工具。

2. 全局工具服务器（通过管理员设置添加）​

管理员可以管理共享工具服务器，使其在整个部署范围内对所有用户或选定用户可用：

  • 进入 🛠️ 管理员设置 > 工具。
  • 像在用户设置中一样添加工具服务器 URL。
  • 这些工具与开放式 WebUI 内置工具类似。

👉 可选：使用 mcpo 的配置文件​

如果您通过 mcpo 使用配置文件运行多个工具，请注意：

🧩 每个工具都挂载在其自己的唯一路径下！

例如，如果您同时通过 mcpo 使用内存和时间工具，它们将在不同的路由下可用：

这意味着：

  • 在开放式 WebUI 中连接工具时，您必须输入特定工具的完整路径，而不能仅输入根 URL（http://localhost:8000）。
  • 在开放式 WebUI 设置中分别使用它们的子路径 URL 添加每个工具。

MCPO 配置工具设置

✅ 正确:

http://localhost:8000/time
http://localhost:8000/memory

🚫 不有效:

http://localhost:8000

这样可以确保开放式 WebUI 正确识别并与每个工具服务器通信。

第三步：确认您的工具服务器已连接 ✅​

成功连接工具服务器后，开放式 WebUI 会在消息输入区域直接显示一个 👇 工具服务器指示器：

📍 您将看到输入框下方的这个图标：

工具服务器指示器

点击此图标会打开一个弹出窗口，您可以：

  • 查看连接的工具服务器信息
  • 查看可用工具以及提供这些工具的服务器
  • 如果需要，可以调试或断开某工具

🔍 以下是工具信息弹窗的样式：

工具信息弹窗展开视图

🛠️ 全局工具服务器显示方式不同，并且默认隐藏！​

如果您连接的是全局工具服务器（即管理员配置的工具服务器），它不会像用户工具服务器那样自动出现在输入区域。

而是：

  • 全局工具默认隐藏，需要用户明确激活。
  • 若要启用它们，您需要点击消息输入区左下角的 ➕ 按钮，并手动激活您想使用的特定全局工具。

如下所示：

全局工具服务器消息输入区

⚠️ 针对全局工具服务器的重要注意事项：

  • 在启用之前，它们不会出现在工具指示器弹窗中。
  • 每个全局工具都必须单独切换才能在您当前聊天中激活。
  • 一旦激活，其功能与用户工具相同。
  • 管理员可以通过基于角色的权限控制全局工具的访问。

这非常适合团队设置或共享环境，其中需多用户可以集中访问常用工具（例如文档搜索、记忆或网络查找）。

（可选）步骤4：使用“原生”函数调用（ReACT风格）工具 🧠​

信息

为了让此功能有效运行，您选择的模型必须支持原生工具调用。某些本地模型声称支持但通常效果不佳。我们强烈建议使用GPT-4o或其他支持原生函数调用的OpenAI模型以获得最佳体验。

想在对话中直接启用ReACT风格（推理 + 行动）的原生函数调用吗？您可以切换Open WebUI以使用原生函数调用。

✳️ 如何启用原生函数调用：

  1. 打开聊天窗口。
  2. 转到 ⚙️ Chat Controls > Advanced Params。
  3. 将 Function Calling 参数从 Default 更改为 Native。

原生工具调用

需要更多工具？探索与扩展！ 🧱​

openapi-servers 仓库包含各种有用的参考服务器：

  • 📂 文件系统访问
  • 🧠 记忆与知识图谱
  • 🗃️ Git仓库浏览
  • 🌎 网络搜索（开发中）
  • 🛢️ 数据库查询（开发中）

您可以以相同方式运行以上任意项，并通过重复上述步骤将其连接到Open WebUI。

故障排除与提示 🧩​

  • ❌ 无法连接？请确保URL正确且能从运行Open WebUI的浏览器访问。
  • 🔒 如果您使用的是远程服务器，请检查防火墙和HTTPS配置！
  • 📝 要使服务器持久化，请考虑使用Docker或系统服务部署它们。

需要帮助？访问 👉 讨论页面 或 提交问题。