Brain Dump MCP 服务器
- 项目简介
- 该仓库实现了一个完整的 MCP 服务器,用于向大型语言模型客户端提供结构化的资源(Resources)、可注册并调用的工具(Tools)以及可渲染的提示模板(Prompts),并通过 JSON-RPC 进行请求/响应和通知传输。
- 主要功能点
- 资源、工具与 Prompts 的集中注册与管理,支持多环境的上下文服务能力
- JSON-RPC 风格的请求/响应处理,兼容 MCP 客户端对资源、工具、Prompts 的读取与执行
- 会话管理与能力声明,涵盖会话生命周期、工具执行跟踪、以及对话/数据的审计钩子
- 支持多种传输协议的服务器端接入(如标准 IO、HTTP SSE、WebSocket 等虚拟实现路径),便于 LLM 客户端接入
- 集成本地 SQLite 数据库作为数据与状态存储,提供完整的数据模型与迁移支持
- 安装步骤
- 克隆仓库并进入项目目录
- 安装依赖并准备构建环境(如 TypeScript、ts-node/tsx 等工具)
- 启动 MCP 服务器(通过 Node 直接执行 MCP 入口,或按项目文档提供的运行方式)
- 服务器配置(适用于 MCP 客户端连接)
- 服务器名称(serverName):Brain Dump
- 启动命令(command):node 或 tsx/ts-node 方式执行 MCP 入口
- 启动参数(args):用于指定工作目录、数据路径等运行时配置的参数集合
- 连接方式:MCP 客户端通过配置 JSON 连接到服务器(包含 serverName、command、args 等信息即可启动并建立连接)
- 配置示例说明(以 JSON 表达的配置描述,非代码块呈现,以下为可理解文本格式):
- serverName: "brain-dump"
- command: "tsx"
- args: ["mcp-server/index.ts"]
- 说明:上述启动方式会让 MCP 客户端通过标准输入输出(stdio)进行 JSON-RPC 交互,服务器端实现会绑定相应的工具、资源和提示模板,提供完整的 MCP 功能。
- 基本使用方法
- 启动后,MCP 客户端通过 JSON-RPC 调用服务器提供的工具(如 project、ticket、epic 等),并通过服务器返回的标准化 MCP 内容结构获得结果
- 客户端可以请求读取资源、执行工具、获取 Prompts 以及订阅/接收通知
- 服务器负责会话创建与结束、能力声明,以及对多环境传输的适配与扩展