使用说明

项目简介

该项目 'mcp-librechat' 提供了一组 MCP (Model Context Protocol) 服务器的示例配置,旨在演示如何将 MCP 服务器与 LibreChat 结合使用。它包含了多个预配置的 MCP 服务器,每个服务器都提供不同的工具集,扩展了 LibreChat 的功能,使其能够与外部服务和应用进行交互。

主要功能点

  • Brave 搜索工具 (brave-search): 允许 LLM 通过 Brave 搜索引擎进行网页和本地搜索,获取网络信息和本地商业信息。
  • 网页内容抓取工具 (fetch): 提供从指定 URL 抓取网页内容的功能,并支持将 HTML 转换为 Markdown 格式,方便 LLM 理解和处理网页信息。
  • 简单数学计算工具 (add): 一个基础的示例工具,用于演示如何创建和注册简单的数学运算工具,例如加法。
  • Factorio 服务器控制工具 (factorio): 提供了一系列工具,用于远程控制 Factorio 游戏服务器,例如执行命令、获取玩家信息、发送消息、给予物品、传送玩家和截图等。
  • 智能门锁控制工具 (door): 演示了如何通过 MCP 服务器控制智能家居设备,例如智能门锁的锁定和解锁功能。
  • Docker Compose 部署: 使用 Docker Compose 简化了多服务器的部署和管理,用户可以轻松启动和管理所有示例 MCP 服务器。
  • SSE 传输协议: 示例服务器默认使用 SSE (Server-Sent Events) 协议与 MCP 客户端通信。

安装步骤

  1. 安装 Docker 和 Docker Compose: 确保你的系统已安装 Docker 和 Docker Compose。对于 macOS 或 Windows 用户,推荐使用 Docker Desktop。

  2. 克隆仓库: 使用 Git 克隆 'mcp-librechat' 仓库到本地:

    git clone https://github.com/jerome3o/mcp-librechat.git
    cd mcp-librechat
  3. 配置环境变量: 复制 '.env.example' 文件为 '.env',并根据需要配置 API 密钥。

    cp .env.example .env

    你需要配置以下环境变量:

    • 'ANTHROPIC_API_KEY' (用于 LibreChat, 如果使用 Anthropic 模型)
    • 'BRAVE_API_KEY' (用于 Brave 搜索工具,需在 Brave 开发者平台 获取)
    • 'FACTORIO_BACKEND_URL' 和 'FACTORIO_BACKEND_API_KEY' (用于 Factorio 服务器控制工具,需要自行搭建 Factorio RCON 后端服务并设置密钥)
    • 'DOOR_API_KEY' 和 'DOOR_URL' (用于智能门锁控制工具,需要自行搭建智能门锁 API 服务并设置密钥)
  4. 启动服务器: 使用 Docker Compose 启动所有服务:

    docker compose up -d --build

    可能需要使用 'sudo' 命令。

  5. 访问 LibreChat: 在浏览器中访问 'https://localhost:3080/',注册并登录 LibreChat。

  6. 配置 Agent 和添加工具: 在 LibreChat 中配置 Agent,并在工具设置页面添加 MCP 工具。在工具列表的第二页可以看到示例 MCP 服务器提供的工具。保存 Agent 配置后即可开始使用 MCP 工具进行对话。

服务器配置

以下 JSON 配置信息可用于 MCP 客户端连接到 'brave-search' MCP 服务器。其他服务器的配置类似,只需修改 'server name' 和 'args' 中的端口号即可。

{
  "server name": "brave-search-mcp",
  "command": "docker",
  "args": [
    "compose",
    "exec",
    "-T",
    "brave-search-server",
    "node",
    "dist/index.js"
  ],
  "description": "Brave 搜索 MCP 服务器",
  "capabilities": {
    "tools": {}
  },
  "transport": {
    "type": "sse",
    "baseUrl": "http://localhost:3080"
  }
}

配置参数说明:

  • 'server name': MCP 服务器的名称,用于在客户端中标识和管理服务器连接。 例如 '"brave-search-mcp"'。
  • 'command': 启动 MCP 服务器的命令。 在 Docker 环境中,这里使用 'docker compose exec -T brave-search-server node dist/index.js' 命令进入 'brave-search-server' 容器并执行启动脚本。
  • 'args': 启动命令的参数,以数组形式提供。 '["compose", "exec", "-T", "brave-search-server", "node", "dist/index.js"]' 这些参数会被传递给 'command'。
  • 'description': 对 MCP 服务器的简要描述,方便用户理解服务器的功能。 例如 '"Brave 搜索 MCP 服务器"'。
  • 'capabilities': 声明服务器提供的能力,例如 'tools: {}' 表示该服务器提供工具功能。
  • 'transport': 配置与 MCP 服务器通信的传输协议。
    • 'type': 传输协议类型,这里使用 '"sse"' (Server-Sent Events)。
    • 'baseUrl': MCP 服务器的根 URL,客户端将通过此 URL 建立连接。 这里是 '"http://localhost:3080"'。

注意: 请根据实际部署环境和需求修改上述配置信息。例如,如果 MCP 服务器独立部署,则 'command' 和 'args' 需要修改为直接启动服务器的命令。

基本使用方法

  1. 启动 LibreChat 和 MCP 服务器。
  2. 在 LibreChat 中配置 Agent 并添加 MCP 工具。
  3. 与 Agent 对话,Agent 将根据对话内容和工具的功能,自动调用 MCP 服务器提供的工具来获取信息或执行操作。
  4. 例如,与配置了 Brave 搜索工具的 Agent 对话时,你可以询问 "最近有什么新闻?" 或 "附近的餐馆有哪些?",Agent 将调用 Brave 搜索工具获取相关信息并返回给你。

更新 MCP 服务器

要更新 MCP 服务器的代码或配置,你需要:

  1. 修改 'servers/' 目录下相应服务器的代码或配置文件。
  2. 重启 Docker Compose 服务以应用更改:
    docker compose down && docker compose up -d --build
    这将会重新构建 Docker 镜像并重启容器,使你的更改生效。

信息

分类

网页与API