跳到主要内容

🔗 Open WebUI 集成

概述​

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

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

步骤 1：启动 OpenAPI 工具服务器​

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

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

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

# Navigate to the time server
cd servers/time

# Install required dependencies
pip install -r requirements.txt

# Start the server
uvicorn main:app --host 0.0.0.0 --reload

运行后，这将在 http://localhost:8000 托管一个本地 OpenAPI 服务器，您可以将 Open WebUI 指向此处。

Time Server

步骤 2：在 Open WebUI 中连接工具服务器​

接下来，将您正在运行的工具服务器连接到 Open WebUI

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

Settings Page

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

在 Open WebUI 中注册工具服务器有两种方式

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

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

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

管理员可以管理在整个部署中可供所有用户或选定用户使用的共享工具服务器

  • 转到 🛠️ 管理员设置 > 工具。
  • 就像在用户设置中一样添加工具服务器 URL。
  • 这些工具的处理方式与 Open WebUI 的内置工具类似。

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

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

🧩 每个工具都挂载在自己独立的路径下！

例如，如果您通过 mcpo 同时使用 memory 和 time 工具，它们将分别在不同的路由下可用

这意味着

  • 在 Open WebUI 中连接工具时，您必须输入该特定工具的完整路由——不要只输入根 URL (http://localhost:8000)。
  • 在 Open WebUI 设置中，使用各自的子路径 URL 分别添加每个工具。

MCPO Config Tools Setting

✅ 正确

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

🚫 无效

http://localhost:8000

这确保 Open WebUI 正确识别并与每个工具服务器通信。

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

工具服务器成功连接后，Open WebUI 将在消息输入区域直接显示一个 👇 工具服务器指示器

📍 您现在会在输入框下方看到这个图标

Tool Server Indicator

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

  • 查看连接的工具服务器信息
  • 查看哪些工具可用以及它们由哪个服务器提供
  • 如需调试或断开任何工具，请在此操作

🔍 工具信息模态框如下所示

Tool Info Modal Expanded

🛠️ 全局工具服务器外观不同 — 且默认隐藏！​

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

取而代之的是

  • 全局工具默认隐藏，必须由每个用户明确激活。
  • 要启用它们，您需要点击消息输入区域（聊天框左下角）的 ➕ 按钮，并手动开启您想使用的特定全局工具。

外观如下所示

Global Tool Server Message Input

⚠️ 全局工具服务器重要提示

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

这非常适合团队设置或共享环境，在这些环境中，常用的工具（例如文档搜索、记忆或网页查找）应由多个用户集中访问。

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

信息

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

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

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

  1. 打开聊天窗口。
  2. 转到 ⚙️ 聊天控制 > 高级参数。
  3. 将函数调用参数从 Default 更改为 Native。

Native Tool Call

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

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

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

您可以以同样的方式运行这些服务器中的任何一个，并通过重复上述步骤将其连接到 Open WebUI。

故障排除与技巧 🧩​

  • ❌ 未连接？请确保 URL 正确，并且可以从运行 Open WebUI 的浏览器访问。
  • 🔒 如果您使用的是远程服务器，请检查防火墙和 HTTPS 配置！
  • 📝 为了使服务器持久运行，请考虑将其部署在 Docker 中或使用系统服务。

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