Codebrain MCP 服务器

使用说明（Markdown 格式）

• 项目简介

  • Codebrain 是一个面向 AI 编码助手的本地化知识上下文服务。它通过 MCP 服务器向 LLM 客户端提供资源（文档/信号等）、工具（可被调用的外部功能）以及可渲染的 Prompt 模板等能力，帮助 LLM 在与代码库协作时获得一致的上下文与约束。

• 主要功能点

  • MCP 服务器实现：实现了通过 JSON-RPC 与客户端通信，暴露工具列表、响应工具调用、以及上下文查询等能力。
  • 工具注册与调用：提供 codebrain_search、codebrain_context、codebrain_validate、codebrain_record、codebrain_status 等工具，便于在 LLM 交互中检索上下文、获取格式化上下文、记录新信号、以及获取系统状态等。
  • 资源与存储：使用本地 SQLite 存储信号、文档、作用域等数据，具备基本的检索与查询能力。
  • 解析与提取模块（示例实现）：包含 Claude Code、会议记录等内容的解析与信号提取（示例性实现，具体提取引擎在 MVP 中占位）。
  • 多传输协议支持：当前实现以 StdIO 传输为核心，同时设计可扩展以支持 SSE、WebSocket 等传输。

• 安装步骤

  • 获取代码并安装依赖
  • 根据仓库提供的示署说明，安装 Node.js 运行环境并安装包依赖
  • 构建/编译（若使用 TypeScript 源码需编译成可执行 JS，或使用适配运行方式）
  • 启动 MCP 服务器（下方“服务器配置”给出启动信息示例）
  • 启动后，MCP 客户端（如 Claude Code）可通过 JSON-RPC 与服务器进行通信

• 服务器配置（MCP 客户端需要的最小信息） 说明：MCP 客户端需要提供即可连接的启动配置。以下为基于仓库信息的准确示例，字段含义见备注。 { "serverName": "codebrain", "command": "codebrain", "args": ["serve"], "cwd": "/path/to/your-project" } 说明：

  • serverName: MCP 服务器在客户端端识别的名称，应与仓库实现的一致，这里为 codebrain。
  • command: 启动服务器的命令，示例为 codebrain，需在本地环境中可执行。
  • args: 启动参数，示例为 ["serve"]，表示启动服务器的 MCP 服务模式。
  • cwd: 服务器运行所在的工作目录，指向包含代码脑配置与数据库的项目根目录。

• 基本使用方法

  • 启动服务器：在配置好上述信息的环境中执行提供的启动命令（例如 codebrain serve），确保数据库与存储初始化完成。
  • 客户端交互：通过 Claude Code 等 MCP 客户端向服务器发送读取资源、调用工具、获取 Prompt 模板等请求；服务器返回 JSON-RPC 响应或通知。
  • 日常使用场景：在开发中通过 codebrain_search、codebrain_context 等工具查询历史信号、获取范围化上下文、以及记录新的信号，持续丰富本地知识库。