BetterDB Memory MCP 服务器
使用说明
- 项目简介
- 该仓库实现了一个面向 LLM 客户端的后端服务,遵循 Model Context Protocol(MCP)标准,核心职责是统一暴露资源管理、工具执行和 Prompt 模板渲染能力,支持通过不同传输协议进行通信,适配 Claude Code 等集成场景。
- 服务器通过 JSON-RPC 与客户端通信,接收读取资源、执行工具、获取 Prompt 等请求,并返回结构化响应。
- 主要功能点
- MCP 核心能力:提供可注册的工具(Tools)、资源(Resources)与 Prompts,统一管理会话上下文和能力声明。
- 资源与向量检索:与向量数据库/索引集成,提供历史会话检索、摘要能力,以及会话上下文注入。
- 工具注册与执行:内置工具集如 search_context、store_insight、list_open_threads、forget,允许 LLM 调用外部功能并获取结果。
- Prompt 渲染:提供统一的摘要/模板渲染逻辑,确保不同模型提供者输出的结构一致。
- 多传输协议框架:当前实现通过标准的 MCP 服务器(包括 Stdio 传输)进行通信,便于嵌入到 CLAUDE CODE 或其他环境。
- 会话与 aging 流水线:集成了会话捕获、 aging、压缩、知识蒸馏等能力,确保长期存储与检索效率。
- 安装步骤
- 准备运行环境:安装 Bun / Node 生态和 Claude Code 环境(若需与 Claude Code 集成)。
- 安装并构建本对 MCP 服务器的二进制组件(参考仓库中的安装脚本与二进制打包流程)。
- 运行安装流程以注册 Hook 与 MCP 服务,确保 Valkey、向量索引等依赖就绪。
- 启动 MCP 服务器后,通过 MCP 客户端配置与 Claude Code 等客户端进行连接。
- 服务器配置(MCP 客户端需要的连接信息,以下为 JSON 配置示例描述;实际需要将具体字段写成客户端可用的配置)
{
"serverName": "betterdb-memory",
"command": "/path/to/mcp-server", // 运行 MCP 服务器的命令路径(可执行文件名)
"args": [ ], // 启动参数,若需要指定传输等选项可在此添加
"transport": "stdio" // 使用的传输模式:如 stdio(与 Claude Code 的集成方式一致)
}
注释说明:
- serverName:服务器在客户端中的唯一标识名称,避免冲突。
- command/args:启动 MCP 服务器的命令及参数,确保客户端在连接时能正确启动并与服务器建立通信。
- transport:明确通信传输方式,本文实现以标准输入输出(stdio)为载体,便于嵌入式使用。
- 基本使用方法
- 启动阶段:按照安装流程完成服务器构建与注册,确保 MCP 服务对外可用。
- 客户端接入:在 MCP 客户端配置中指向上述 serverName,使用 JSON-RPC 向服务器发起请求,读取资源、调用工具、获取 Prompt 等能力。
- 调试与运维:通过日志、健康检查与集成测试用例,确保资源、工具与 prompts 的正确性与性能;必要时参与迁移/扩 Embedding/Prompts 的升级流程。