项目简介

这是一个基于 Model Context Protocol (MCP) 实现的服务器应用,旨在帮助 AI 助手(如使用 MCP 协议的客户端)管理和维护代码项目的上下文信息。它通过一组标准化的 MCP 工具,让 AI 能够与一个本地文件目录(称为“记忆库”)进行交互,从而持久化项目相关的笔记、决策、进度等信息,确保上下文在不同会话中得到保留。

主要功能点

该服务器提供以下工具,供 AI 助手调用:

  • 初始化记忆库: 创建用于存储项目文件的特定目录和预定义的Markdown文件,并填充初始模板。
  • 检查记忆库状态: 查看记忆库目录是否存在,并列出其中已有的项目文件。
  • 读取记忆库文件: 获取指定项目文件的全部内容,供AI助手获取上下文信息。
  • 追加记忆库条目: 在指定项目文件中追加新的内容,可选择添加到特定标题下方,并自动添加时间戳。

安装步骤

  1. 从 GitHub 克隆项目仓库到本地:
    git clone https://github.com/IncomeStreamSurfer/roo-code-memory-bank-mcp-server.git
    cd roo-code-memory-bank-mcp-server
  2. 安装项目依赖:
    npm install
  3. 构建项目:
    npm run build
    这会将 TypeScript 代码编译到 'dist/' 目录下,生成可执行的 JavaScript 文件。

服务器配置

该 MCP 服务器通常不会手动运行,而是由 MCP 客户端(如 Cline)根据配置自动启动。你需要将此服务器的配置信息添加到你的 MCP 客户端的设置文件中。配置信息通常包含在一个 JSON 对象中,用于描述如何启动服务器以及其属性。

你需要为这个服务器添加一个配置条目,指定一个唯一的服务器名称(例如:'roo-code-memory-bank-mcp'),以及启动服务器所需的命令和参数。

  • 启动命令 (command): 通常设置为 'node',因为服务器是 Node.js 应用。
  • 启动参数 (args): 这是一个字符串数组,第一个参数必须是服务器主脚本的绝对路径。例如,如果你的服务器文件在 '/path/to/your/cloned/repo/roo-code-memory-bank-mcp-server/dist/index.js',那么参数应包含这个路径。请务必替换为你系统中实际的文件路径。
  • 传输类型 (transportType): 设置为 'stdio',表示服务器使用标准输入/输出进行通信。

其他可选配置包括 'autoApprove' (自动批准调用的工具列表) 和 'disabled' (是否禁用)。

基本使用方法

AI 助手通过调用该服务器提供的工具来管理项目记忆库。典型的交互流程可能如下:

  1. 开始任务时: AI 调用 'check_memory_bank_status' 检查记忆库是否存在。
  2. 获取上下文: 如果记忆库存在,AI 调用 'read_memory_bank_file' 读取相关的项目文件(如 'productContext.md', 'activeContext.md')来加载当前项目状态和背景信息。
  3. 记录进展/决策: 在任务进行中,当做出重要决策或取得关键进展时,AI 调用 'append_memory_bank_entry' 将相关信息追加到对应的文件(如 'decisionLog.md', 'progress.md')。
  4. 初始化(如需): 如果记忆库不存在,AI 可以调用 'initialize_memory_bank' 进行首次设置。

记忆库文件('memory-bank/' 目录)将创建在启动服务器进程的工作目录下,通常是该项目仓库的根目录。

信息

分类

数据库与文件