OpenWebUI MCP 服务器使用说明

项目简介

OpenWebUI MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在桥接 Cline 等 MCP 客户端与 OpenWebUI 平台。它通过 MCP 协议将 OpenWebUI 的能力以标准化的方式暴露给客户端，目前主要聚焦于知识库的集成和检索功能。

主要功能点

工具注册与调用: 注册了 'upload_file' (文件上传) 和 'chat_with_rag' (基于 RAG 的对话) 两个工具，允许 MCP 客户端调用 OpenWebUI 的文件上传和检索增强生成 (RAG) 功能。
OpenWebUI 集成: 作为 OpenWebUI 的 MCP 网关，使得 MCP 客户端能够利用 OpenWebUI 强大的后端能力，例如文档管理和智能对话。
标准化 MCP 协议: 遵循 MCP 协议规范，确保与任何兼容 MCP 协议的客户端（如 Cline）无缝对接。
Stdio 传输: 使用 Stdio 作为默认的传输协议，简化部署和集成。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm。
克隆仓库: 'git clone https://github.com/Welkon/Openwebui-server.git'
进入项目目录: 'cd Openwebui-server'
安装依赖: 'npm install'

服务器配置

MCP 客户端需要配置以下 JSON 对象以连接到 OpenWebUI MCP 服务器。请根据你的实际环境修改以下配置。

{
  "serverName": "OpenWebUI-server",
  "command": "node",
  "args": [
    "dist/index.js"
  ],
  "env": {
    "OPENWEBUI_API_URL": "<你的 OpenWebUI API 地址>",  //  请替换为你的 OpenWebUI API 基础 URL，例如 "http://localhost:8080/api"
    "OPENWEBUI_API_KEY": "<你的 OpenWebUI API 密钥>",   //  请替换为你的 OpenWebUI API 密钥
    "DEFAULT_MODEL": "<默认模型名称>"                 //  请替换为你想使用的默认模型名称，例如 "llama2"
  }
}

配置参数说明:

'serverName': 服务器名称，可以自定义。
'command': 启动服务器的命令，这里使用 'node'。
'args': 启动命令的参数，指向编译后的 JavaScript 入口文件 'dist/index.js'。
'env': 环境变量配置，包含以下必须项��
- 'OPENWEBUI_API_URL': 必须配置，OpenWebUI API 的根 URL。
- 'OPENWEBUI_API_KEY': 必须配置，用于访问 OpenWebUI API 的密钥。
- 'DEFAULT_MODEL': 必须配置，指定用于 RAG 对话的默认模型名称。

注意: 在生产环境中，建议使用 'npm run start' 启动服务器，并确保已提前使用 'npm run build' 构建项目。

基本使用方法

启动服务器: 在项目根目录下运行 'npm run dev' (开发环境) 或 'npm run start' (生产环境)。
配置 MCP 客户端: 将上述服务器配置 JSON 填入你的 MCP 客户端（如 Cline）的服务器配置中。
使用客户端调用工具: 在 MCP 客户端中，你可以调用 'upload_file' 工具上传文件到 OpenWebUI，或调用 'chat_with_rag' 工具与 OpenWebUI 的知识库进行对话。

例如，在 Cline 中，你可以通过工具调用面板，选择 'chat_with_rag' 工具，并输入 'query' 参数发起基于 RAG 的对话。

关键词