ClawRAG MCP Server

使用说明 Markdown 格式说明

项目简介

  • ClawRAG MCP Server 是一个实现 MCP(Model Context Protocol)的后端服务器组件,旨在为大模型客户端(如 OpenClaw)提供统一的上下文服务入口。通过 MCP 服务,客户端可以读取知识资源、注册并执行工具,以及获取和渲染提示模板等能力。

主要功能点

  • MCP 核心能力
    • 提供 MCP 服务器端实现,支持多传输通道(stdio、SSE、HTTP 等)。
    • 暴露工具集:query_knowledge、list_collections 等,供客户端调用以实现知识查询和集合发现。
    • 提供服务器卡(server-card.json)等元数据,用于客户端注册和自描述。
  • 与后端系统的对接
    • 通过 HTTP/JSON-RPC 调用 ClawRAG 的 API 实现资源访问、查询、清单等功能。
    • 与 OpenClaw 等客户端通过 MCP 进行交互,构建自描述的服务器端能力。
  • 运行与部署
    • 提供 StdIO 及 HTTP SSE 两种接入方式,适配不同部署场景。
    • 具备一个测试客户端(示例代码)用于本地快速验证 MCP 服务器行为。

安装与运行步骤

    1. 安装必要依赖
    • 该仓库包含 MCP 服务器实现和相关依赖,通常需要 Node.js/TypeScript 构建输出以及 MCP 库依赖。
    1. 构建并启动 MCP 服务器
    • 使用仓库提供的入口脚本(如 mcp-server/src/server.ts 对应的打包输出)启动 MCP 服务器。
    • 支持两种模式:
      • stdio 模式:通过命令行运行,服务器通过标准输入输出与客户端通信。
      • http 模式:通过 HTTP SSE 传输与客户端通信,提供 /sse 端点和 .well-known/mcp/server-card.json 等元信息。
    1. 客户端注册与调用
    • MCP 客户端需要配置服务器信息(server card)及连接参数,具体连接方式可参考客户端工具的文档。
    • 客户端通过 MCP 的 JSON-RPC 调用向 MCP 服务器发起请求(如工具执行、资源查询、集合列表等)。
    1. 快速自检
    • 使用仓内提供的测试客户端脚本开始一个简单的 MCP 会话,查看服务器输出与响应。

服务器配置(MCP 客户端所需信息,注意:MCP 客户端无需运行该配置,本节仅供参考) { "server_name": "clawrag", "command": "node", "args": ["path/to/build/server.js"] } 注释:

  • server_name:MCP 客户端在对等环境中的唯一标识名,用于日志、发现和路由。
  • command:启动 MCP 服务器的命令,通常为 node(若直接编译成可执行二进制也可)。
  • args:启动服务器的参数列表,此处指向构建输出的入口文件;客户端会启动并通过标准输入输出或基于 SSE 的传输方式与 MCP 服务器通信。

基本使用方法

  • 与客户端建立连接
    • 通过客户端工具将服务器地址、传输方式(stdio/SSE/HTTP)等信息配置好后,即可建立连接并通过 MCP 调用进行资源访问、工具执行、Prompt 获取等操作。
  • 调用示例(概览)
    • 列出知识集合、执行知识查询、获取并渲染提示模板等能力。
    • MCP 工具通常包含: list_collections、query_knowledge、以及其他自定义工具,客户端通过 RPC 调用即可获得格式化结果。

注意事项

  • MCP 服务端依赖 ClawRAG 的后端 API(/api/v1/rag/... 等)进行实际数据访问,需确保后端服务可用且网络连通。
  • 部署时请根据实际环境选择 stdio 或 HTTP SSE 传输,并按需暴露 .well-known/mcp/server-card.json 提供服务器元数据。

关键词 Model Context Protocol, OpenClaw, 资源管理, 工具注册, JSON-RPC, Prompts

分类ID 6

服务器信息