使用说明

项目简介

Trieve 是一个开源的、一体化的解决方案,旨在为开发者提供强大的搜索、推荐和检索增强生成(RAG)能力。其 MCP 服务器组件专注于为大型语言模型(LLM)客户端提供上下文服务,支持资源管理、工具注册和 Prompt 模板定义,从而简化 LLM 应用的后端开发。

主要功能点

  • 资源管理: Trieve MCP 服务器可以托管和管理用于 LLM 应用的各种数据资源,例如文档、知识库等。
  • 语义和全文本搜索: 利用向量搜索和关键词搜索技术,提供高效、准确的上下文检索能力,支持 typo 容错和子句高亮。
  • 推荐系统: 内置推荐 API,可以根据用户行为(如收藏、点赞)推荐相似内容。
  • RAG API: 集成 OpenRouter,支持灵活的 RAG 流程,并允许用户自带 LLM 模型。
  • 工具集成: 虽然文档中没有明确提及“工具 (Tools)”的注册和执行,但作为一个 RAG 解决方案,Trieve 可以通过其 API 扩展工具集成能力,例如调用外部 API 获取实时信息。
  • Prompt 模板: 虽然文档没有直接说明 Prompt 模板功能,但 RAG 功能本身就涉及到 Prompt 的构建和管理,用户可以通过 Trieve API 定制 RAG 流程中的 Prompt。
  • 自托管: 支持在 VPC 或本地环境自托管,保证数据安全和更高的定制化能力。

安装步骤

Trieve MCP 服务器可以通过多种方式安装,以下是使用 Smithery 和本地 Linux 开发环境的安装步骤:

1. 使用 Smithery 安装 (推荐 Claude 客户端)

npx -y @smithery/cli install trieve-mcp-server --client claude

2. 本地 Linux 开发环境安装 (Debian/Ubuntu 为例)

  • 安装依赖包:
    sudo apt install curl \\
    gcc \\
    g++ \\
    make \\
    pkg-config \\
    python3 \\
    python3-pip \\
    libpq-dev \\
    libssl-dev \\
    openssl
  • 安装 NodeJS 和 Yarn:
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
    重启终端后,执行:
    nvm install --lts
    npm install -g yarn
  • 创建 server tmp 目录:
    mkdir server/tmp
  • 安装 Rust 和 cargo-watch:
    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    cargo install cargo-watch
  • 配置环境变量:
    cp .env.analytics ./frontends/analytics/.env
    cp .env.chat ./frontends/chat/.env
    cp .env.search ./frontends/search/.env
    cp .env.server ./server/.env
    cp .env.dashboard ./frontends/dashboard/.env
    编辑 './server/.env' 文件,填入你的 'LLM_API_KEY' (例如 OpenAI API Key)。
  • 启动 Docker 容器服务:
    cat .env.chat .env.search .env.server .env.docker-compose > .env
    ./convenience.sh -l
  • 启动本地开发服务 (推荐使用 tmuxp 或多终端)
    cd clients/ts-sdk
    yarn build
    cd frontends
    yarn
    yarn dev
    cd server
    cargo watch -x run
    cd server
    cargo run --bin ingestion-worker
    cd server
    cargo run --bin file-worker
    cd server
    cargo run --bin delete-worker
    cd search
    yarn
    yarn dev

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令及其参数。由于 Trieve MCP 服务器基于 Rust 和 Cargo 构建,并且通过 Smithery 可以便捷安装,以下提供一个基础的 JSON 格式配置示例。请根据实际部署情况调整命令和参数。

{
  "serverName": "trieve-mcp-server",
  "command": "cargo",
  "args": [
    "run",
    "--bin",
    "server"
  ],
  "description": "Trieve MCP Server for search, recommendations, and RAG",
  "transport": "stdio",
  "protocol": "json-rpc"
}

参数注释:

  • serverName: 服务器名称,可以自定义,用于在 MCP 客户端中标识服务器。
  • command: 启动服务器的可执行命令,这里假设使用 'cargo run' 运行 Rust server 目录下的 'server' 二进制文件。 [请注意] 实际命令可能需要根据 Trieve MCP 服务器的具体构建和部署方式进行调整。 如果是通过 Smithery 安装,可能需要查找 Smithery 提供的启动脚本或命令。
  • args: 启动命令的参数列表。 '["run", "--bin", "server"]' 是使用 Cargo 运行 'server' 二进制文件的常见参数。 [请注意] 实际参数可能需要根据 Trieve MCP 服务器的具体配置和需求进行调整。例如,可能需要指定配置文件路径、端口号等。
  • description: 服务器的简要描述,方便用户理解服务器用途。
  • transport: MCP 客户端与服务器通信的传输协议,这里假设使用 'stdio' (标准输入输出)。Trieve 也可能支持 'sse' 或 'websocket',具体取决于实际实现。
  • protocol: MCP 客户端与服务器通信的协议,这里明确指定为 'json-rpc'。

[重要提示] 上述服务器配置为 基础示例,实际 Trieve MCP 服务器的启动命令和参数可能需要参考官方文档或联系维护者获取准确信息。特别是 'command' 和 'args' 字段,需要根据服务器的部署方式和启动脚本进行适配。

基本使用方法

  1. 启动 Trieve MCP 服务器: 根据上述安装步骤启动 Trieve MCP 服务器。
  2. 配置 MCP 客户端: 在支持 MCP 协议的 LLM 客户端 (例如 Claude) 中,配置上述 JSON 格式的服务器信息。
  3. 连接服务器: 在 MCP 客户端中连接到 Trieve MCP 服务器。
  4. 利用 RAG 功能: 通过 LLM 客户端,向 Trieve MCP 服务器发送 RAG 请求,利用其搜索和上下文检索能力增强 LLM 的回答质量。
  5. 探索更多 API 功能: 查阅 Trieve API 文档 (例如 OpenAPI 参考文档 localhost:8090/redoc),了解更多可用的 API 接口,例如推荐、数据管理等功能。

请注意: 由于提供的仓库信息主要是 Python SDK 和 README 文件,关于 Trieve MCP 服务器的详细协议和功能使用方法,请务必参考 Trieve 官方文档和社区支持渠道获取最准确的信息。

信息

分类

AI与计算