TeaRAGs-MCP

关键词

离线向量检索代码知识库资源与工具服务JSON-RPC MCP 服务本地AI上下文

使用说明内容（Markdown格式）

  • 项目简介 TeaRAGs-MCP 是一个基于 MCP（Model Context Protocol）的后端服务器实现，核心职责是把代码环境中的资源、工具和提示模板以标准化的方式暴露给运行在本地或私有环境中的大模型客户端，用于向模型提供上下文、执行外部功能以及提供可配置的对话模板。

  • 主要功能点

    • 资源管理（Resources）：托管并提供数据访问能力，例如代码库、集合信息等。
    • 工具注册与执行（Tools）：注册并执行外部功能接口，LLM 可以调用这些工具完成任务（如代码检索、代码索引、删除/添加数据等）。
    • 提示模板（Prompts）：定义并渲染可复用的 Prompt 模板，帮助统一化 LLM 的交互指令。
    • JSON-RPC 通信：服务器通过 JSON-RPC 与客户端进行请求/响应交互。
    • 会话与能力声明：服务器端管理会话、暴露自身能力，支持多传输协议。
    • 本地化与脱离网络能力：具备本地向量数据库、嵌入模型等本地能力，适合本地私有部署。
    • 多种传输协议：支持 stdio、HTTP 等传输通道，方便在不同环境中接入。

  • 安装步骤

    • 克隆仓库并安装依赖（如 npm install）
    • 构建前端/后端代码，得到可执行的构建产物
    • 启动服务（示例中提供两种启动方式：stdio 与 http，具体见仓库自述文档）
    • 如需使用嵌入模型，按需配置 Ollama/OpenAI/Cohere/Voyage 等提供者以及本地模型
    • 若要在 Claude 等代理中注册 MCP 服务，请根据快速入门文档完成集成

  • 服务器配置（MCP 客户端需要的配置，JSON 格式） 注：以下信息来自本仓库的实现与快速入门描述，请据实际运行环境替换路径与参数。 { "serverName": "tea-rags-mcp", "command": "node", "args": ["build/index.js"], "transport": "stdio", "description": "TeaRAGs MCP 服务入口，默认通过 stdio 传输暴露 MCP API，后续可切换到 http 传输。", "notes": "构建产物位于项目的 build/index.js；在本地私有环境中，常与 Claude Code 等代理集成使用。" }

  • 基本使用方法

    • 启动后端：按照仓库提供的快速入门方式，使用 stdio 或 HTTP 传输启动 TeaRAGs-MCP。
    • 连接客户端：MCP 客户端通过上述配置与服务器建立连接，进行资源读取、工具调用和 Prompts 渲染等操作。
    • 使用场景示例：通过工具调用执行数据访问、通过 Prompts 渲染向导、通过资源读取获取代码上下文。
    • 如遇需要，通过环境变量调整嵌入提供者、传输模式、并发与性能参数，提升本地离线能力。

  • 备注

    • 本实现对 MCP 的核心能力进行了较完整的覆盖，包含资源、工具、Prompts 的注册与暴露，以及对 JSON-RPC 的处理与传输层抽象。
    • 如需进一步扩展，请参考源码中各模块（resources、tools、prompts、code、qdrant、embeddings 等）以及测试用例，了解具体的 API 约束和使用方式。

服务器信息

访问项目