Brakit MCP Server

使用说明

  • 项目简介 Brakit 的 MCP 服务端实现,作为后端服务向 MCP 客户端提供资源(数据访问能力)、工具(外部功能调用)以及提示模板(Prompts),并通过 JSON-RPC 与客户端进行请求/响应交互,便于在 LLM 应用中获取上下文信息和能力。
  • 主要功能点
    • MCP 服务端实现核心请求/响应:按 MCP 规范接收客户端请求,返回标准化的 JSON-RPC 响应信息。
    • 资源、工具与 Prompts 的管理与渲染:托管可以被 LLM 调用的数据资源、可执行的工具集合,以及可定制的提示模板。
    • 会话与能力声明:支持会话上下文、能力声明,并与前置存储(如指标、日志、发现机制)结合进行分析与推理。
    • 与 Brakit 平台集成:作为 Brakit 的一个模块运行,能够与分析引擎、仪表盘、以及安全/性能规则协同工作。
    • 多传输协议支持(如 StdIn/StdOut、SSE、WebSocket 等等,按 MCP 规范实现传输通道)。
  • 安装与运行步骤
    1. 安装依赖并构建代码
      • 通过 npm 安装并构建项目以产出可执行的 MCP 服务文件。
    2. 启动 MCP 服务器
      • 通过命令行启动 Brakit 的 MCP 服务模块(会由 CLI 提供入口,例如 brakit mcp),服务启动后即可接受 MCP 客户端的连接请求。
    3. 连接 MCP 客户端
      • MCP 客户端按照 MCP 规范配置服务器信息、启动命令及参数,与服务器建立连接并执行资源、工具、 prompts 的读取与执行等操作。
  • 服务器配置(给 MCP 客户端的配置信息,客户端不需要对本仓库的实现细节进行修改) 说明:以下为示例配置要点,实际连接时请使用与部署环境相匹配的路径和参数。信息仅作参考,不包含具体实现代码。
    • serverName: brakit
    • command: node
    • args: ["./dist/mcp/server.js"] 备注:在构建产物输出路径中,mcp/server.ts 的入口会被打包为 dist/mcp/server.js,实际路径请以构建产物为准。
    • 描述:启动 MCP 服务端,提供对外的 MCP JSON-RPC 接口与能力。 注释:客户端会通过该服务器的启动命令和参数建立连接,因此以上 fields 需以实际运行环境的可执行路径和参数为准。
  • 基本使用方法
    • 启动后,MCP 客户端连接并请求资源、工具和 Prompts。
    • 客户端可通过 JSON-RPC 调用工具、读取资源、获取并渲染 Prompts,服务器按 MCP 规范返回结果或通知。
    • 服务器会进行会话管理、能力声明,并在需要时与 Brakit 的分析引擎、仪表盘及工具集协同工作。

服务器信息