memory-bank-mcp

🚀 内存库MCP

一款用于人工智能辅助开发的引导式内存库插件

Memory Bank MCP是一个模型上下文协议（MCP）插件，它借助结构化的Markdown文件，帮助AI助手持续维护项目上下文。该插件通过引导式指令而非直接操作，提供了一种系统的方法来跟踪项目目标、决策、进度和模式。

🚀 快速开始

1. 初始化内存库

   使用 init-memory-bank 创建 memory-bank 目录和核心文件
   

2. 读取内存库

   使用 get-memory-bank-info 查看所有内存库内容
   

3. 更新内存库

   使用 update-memory-bank 获取更新特定文件的指导
   

✨ 主要特性

• 引导式操作：为AI助手提供自行执行操作的说明
• 结构化上下文管理：通过5个核心文件组织项目信息
• 智能引导：提供初始化和更新的逐步指导
• 灵活更新：根据不同的变更类型提供智能更新指导
• 跨平台支持：自动对Windows、macOS和Linux的路径进行规范化处理

MCP配置

使用已发布的npm包：

{
  "mcpServers": {
    "memory-bank": {
      "command": "npx",
      "args": ["@neko0721/memory-bank-mcp"],
      "timeout": 600
    }
  }
}

📚 详细文档

核心文件

1. productContext.md（产品上下文）

• 项目高层概述
• 目标和关键特性
• 整体架构
• 如果存在 projectBrief.md，会自动合并其内容

2. activeContext.md（活动上下文）

• 当前工作状态
• 近期变更
• 未解决的问题和事项
• 关注领域

3. progress.md（进度）

• 以清单形式跟踪任务
• 已完成、当前和计划中的任务
• 进度时间线

4. decisionLog.md（决策日志）

• 架构和实现决策
• 理由和影响
• 决策历史

5. systemPatterns.md（系统模式）

• 重复出现的模式和标准
• 编码规范
• 架构模式
• 测试策略

使用指南

针对AI助手

1. 每次会话开始时：检查 memory-bank 目录是否存在，然后使用 get-memory-bank-info 了解项目状态
2. 必要时进行初始化：对于新项目，使用 init-memory-bank
3. 读取上下文：使用 get-memory-bank-info 了解项目状态
4. 获取更新指导：使用 update-memory-bank 获取更新说明
5. 遵循指导：执行提供的指导以维护内存库

更新触发条件

• 架构变更：重大的结构决策
• 功能完成：新功能或能力
• 错误修复：重要问题的解决
• 重构：代码结构改进
• 决策：任何重要的技术选择
• 进度更新：任务状态变更

工具参考

init-memory-bank

使用所有核心文件初始化内存库。 参数：

• rootPath：项目根目录路径
• force（可选）：强制重新初始化 返回值：已创建的文件列表和下一步操作指导

get-memory-bank-info

读取并返回所有内存库内容（类似于codelf的 get-project-info）。 参数：

• rootPath：项目根目录路径 返回值：为AI上下文格式化后的内存库内容

update-memory-bank

提供更新内存库文件的指导。 参数：

• rootPath：项目根目录路径
• changeType：变更类型（架构/功能/错误修复/重构/决策/进度）
• description：变更的简要描述 返回值：带有模板和时间戳的详细更新说明

集成提示

Cursor设置

在设置 → 规则 → 用户规则中添加：

在开始任何任务之前，检查项目中是否存在 memory-bank 目录。如果不存在，则运行 MCP 命令 init-memory-bank。
在会话开始时，使用 MCP 命令 get-memory-bank-info 读取内存库内容。
完成任务或对话后，必须使用 MCP 命令 update-memory-bank 更新内存库内容。
遵循 MCP 指导维护内存库文件。

Windsurf设置

在设置 → 级联 → 记忆和规则 → 全局规则中添加：

在开始任何任务之前，检查项目中是否存在 memory-bank 目录。如果不存在，则运行 MCP 命令 init-memory-bank。
在会话开始时，使用 MCP 命令 get-memory-bank-info 读取内存库内容。
完成任务或对话后，必须使用 MCP 命令 update-memory-bank 更新内存库内容。
遵循 MCP 指导维护内存库文件。

🤝 贡献

欢迎贡献！请随时提交问题或拉取请求。

📄 许可证

MIT

🙏 致谢

受SPARC方法和codelf的启发。