使用说明

项目简介

LibreChatMCPServers 是一个仓库,它提供了一系列 Model Context Protocol (MCP) 服务器的示例,用于增强 LibreChat 的功能。这些服务器通过 Supergateway 桥接,将标准输入/输出 (stdio) MCP 服务器转换为基于 Server-Sent Events (SSE) 的服务,方便 LibreChat 等 MCP 客户端进行集成。仓库中包含 Brave Search API 的集成示例,并提供了添加新 MCP 服务器的框架和指南。

主要功能点

  • MCP 服务器示例: 提供了如 Brave Search 等开箱即用的 MCP 服务器示例,展示了如何集成外部 API 作为 MCP 资源或工具。
  • Supergateway 桥接: 利用 Supergateway 将 stdio MCP 服务器转换为 SSE 服务,简化了与 LibreChat 等客户端的集成过程。
  • 易于扩展: 提供了清晰的目录结构、Dockerfile 模板和配置指南,方便用户添加和部署自定义的 MCP 服务器。
  • Docker 容器化: 所有服务器都以 Docker 容器方式运行,易于部署和管理,并保证了环境一致性。
  • 配置灵活: 支持通过环境变量和配置文件进行服务器配置,方便用户根据需求进行定制。

安装步骤

  1. 前提条件: 确保已安装 Docker 和 Docker Compose。
  2. 克隆仓库: 从 GitHub 克隆 LibreChatMCPServers 仓库到本地。
    git clone https://github.com/wally-kroeker/LibreChatMCPServers.git
    cd LibreChatMCPServers
  3. 构建和启动: 使用 Docker Compose 构建并启动 Supergateway 和 MCP 服务器。您可能需要根据需要修改 'docker-compose.override.yml' 和 'librechat.yaml' 文件来启用和配置特定的 MCP 服务器。 详细配置请参考仓库中的 README.md 和各个服务器目录下的 README.md 文件。

服务器配置

以下是配置 LibreChat 客户端连接 Brave Search MCP 服务器的示例配置信息(JSON 格式)。请注意,实际使用时您需要根据 LibreChat 客户端的具体配置方法进行设置。

{
  "servers": [
    {
      "serverName": "braveSearch",
      "type": "sse",
      "url": "http://brave-search:8003/sse"
    }
    // 您可以根据需要添加更多 MCP 服务器配置
  ]
}

配置参数说明:

  • 'serverName': 服务器名称,用于在客户端中标识和引用该服务器,例如 "braveSearch"。
  • 'type': 连接类型,这里使用 SSE (Server-Sent Events)。
  • 'url': 服务器 SSE 接口的 URL 地址。'http://brave-search:8003/sse' 表示连接到名为 "brave-search" 的 Docker 服务,端口为 8003,路径为 '/sse'。请确保此 URL 与您实际部署的 MCP 服务器地址一致。

注意:

  • 上述 JSON 配置仅为示例,LibreChat 客户端的具体配置方法和格式请参考 LibreChat 的官方文档。
  • 您需要在 LibreChat 的配置文件 ('librechat.yaml' 或类似文件) 中添加上述服务器配置信息。
  • 确保 Docker Compose 服务 'brave-search' 已经成功启动,并且网络配置允许 LibreChat 客户端访问该服务。

基本使用方法

  1. 启动 MCP 服务器: 通过 Docker Compose 启动 LibreChatMCPServers 仓库中的 MCP 服务器,例如 Brave Search。
  2. 配置 MCP 客户端: 在您的 MCP 客户端 (例如 LibreChat) 中,根据客户端文档配置 MCP 服务器连接信息,使用上面提供的服务器配置示例进行配置。
  3. 使用 MCP 功能: 在 MCP 客户端中,您应该能够使用 MCP 服务器提供的资源和工具。例如,配置 Brave Search MCP 服务器后,您可能可以在 LibreChat 中使用 Brave Search 进行网页搜索等功能(具体功能取决于 Brave Search MCP 服务器的实现)。

请参考各个 MCP 服务器目录下的 README.md 文件,了解更详细的服务器特定配置和使用方法。

信息

分类

开发者工具