Bluera Knowledge MCP 服务器

使用说明(Markdown 格式)

  • 项目简介 Bluera Knowledge 的 MCP 服务器是一套后端服务,负责接收来自 LLM 客户端的 JSON-RPC 请求,提供以下核心能力:托管和管理资源(如本地仓库、网页、文档等)、注册与执行工具(外部功能调用)、以及定义与渲染 Prompt 模板。服务器通过 Model Context Protocol 与客户端建立通信,支持多种传输场景(如标准输入输出、SSE、WebSocket 等),并具备会话管理、能力声明与扩展能力。

  • 主要功能点

    • MCP 协议核心能力:实现对 MCP 请求的接收、解析、处理并返回标准化的 JSON-RPC 响应,支持资源读取、工具调用、Prompts 获取等操作。
    • 资源与工具管理:托管与管理资源(文件、仓库、网页等),注册并执行 Tools,方便 LLM 客户端调用外部功能。
    • Prompt/模板渲染:支持提示模板的定义与渲染,提供可定制的 LLM 互动模式。
    • 与后端组件耦合:结合向量数据库、代码关系图、爬虫等组件,提供上下文丰富的查询能力。
    • 多传输协议支持(示例实现以 Stdio 为主,后续可扩展为 SSE/WebSocket 等)。
  • 安装步骤(简要)

    1. 准备运行环境:Node.js 版本建议与仓库要求相符,确保本地依赖可用。
    2. 构建/运行 MCP 服务器:本仓库提供 TypeScript/JavaScript 实现与 dist 产物,常见做法是在部署环境中直接运行 MCP 服务器入口(如 dist/mcp/server.js),通过 bun/node 运行环境启动。
    3. 设置依赖与数据目录:根据服务器实现,需配置数据目录、配置文件、以及项目根目录等环境变量,确保嵌入模型、向量数据库、以及资源存储等组件可用。
    4. 客户端连接测试:使用 MCP 客户端(或具 MCP 兼容的工具)向服务器发送初始化与工具调用请求,验证 JSON-RPC 响应。
  • 服务器配置(供 MCP 客户端参考) 说明:MCP 客户端需要一个用于启动 MCP 服务器的配置,包含服务器名称、启动命令以及参数。以下为示例配置要素,请按实际部署环境填写注释说明。服务器端的环境变量在实际运行时提供给服务器进程。

    { "serverName": "bluera-knowledge-mcp", "command": "bun", "args": ["dist/mcp/server.js"], "env": { "PROJECT_ROOT": "<项目根目录路径,例如 /workspace/bluera-knowledge>", "DATA_DIR": "<数据目录路径,例如 /workspace/bluera-knowledge/.bluera/bluera-knowledge/data>", "CONFIG_PATH": "<配置文件路径,例如 /workspace/bluera-knowledge/.bluera/bluera-knowledge/config.json>" }, "notes": "MCP 客户端通过该启动信息与服务器建立连接。确保环境变量按实际部署填写,客户端不需要额外代码,只需提供上述启动信息并在需要时调整环境变量。" }

  • 基本使用方法

    • 启动后:客户端通过 MCP 协议向服务器发起 JSON-RPC 请求,进行资源读取、工具调用与提示获取等操作。
    • 常用流程包括:初始化协商、列出可用工具、通过 execute/meta 工具管理存储与作业、执行查询并获取上下文等。
    • 兼容性与扩展:根据需要扩展多传输协议支持(如 SSE/WebSocket),以及将新的工具/资源类型接入 MCP 服务端。

服务器信息