AI辅助开发内存银行插件

Memory Bank MCP是一款帮助AI助手通过结构化Markdown文件维护持久项目上下文的插件,适用于软件开发中的项目目标、决策和进度跟踪。

  • by hoppo-chan
  • JavaScript
  • 本地部署
  • 15 星标
  • 更新于
在 GitHub 查看 hoppo-chan/memory-bank-mcp

使用说明

存储库MCP

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

Memory Bank MCP是一个模型上下文协议(MCP)插件,通过结构化的markdown文件帮助AI助手维护持久的项目上下文。它提供了一种系统的方法,通过指导性指示而不是直接操作来跟踪项目目标、决策、进度和模式。

特性

  • 引导式操作:为人工智能助手提供自行执行操作的说明
  • 结构化上下文管理:跨5个核心文件组织项目信息
  • 智能制导:初始化和更新的分步说明
  • 灵活的更新:基于不同变更类型的智能更新指导
  • 与跨平台支持:Windows/macOS/Linux的自动路径规范化

MCP配置

使用已发布的npm包:

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

快速开始

  1. 初始化内存库

    Use init-memory-bank to create the memory-bank directory and core files
    
  2. 读取存储库

    Use get-memory-bank-info to view all Memory Bank content
    
  3. 更新内存库

    Use update-memory-bank to get guidance on updating specific files
    

核心文件

1.productContext.md(产品上下文)

  • 高级项目概述
  • 目标和关键特征
  • 整体架构
  • 自动合并projectBrief.md(如果可用)

2.activeContext.md(活动上下文)

  • 当前工作状态
  • 最近的更改
  • 未决问题和议题
  • 重点领域

3.进度.md(进度)

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

4.decisionLog.md(决策日志)

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

5.systemPatterns.md(系统模式)

  • 反复出现的模式和标准
  • 编码约定
  • 结构模式
  • 测试策略

使用指南

AI助理

  1. 开始每个会话:检查内存库目录是否存在,然后使用 get-memory-bank-info 了解项目状态
  2. 需要时初始化:使用 init-memory-bank 对于新项目
  3. 阅读上下文:使用 get-memory-bank-info 了解项目状态
  4. 更新指南:使用 update-memory-bank 获取更新说明
  5. 遵照说明:执行提供的指南以维护记忆库

更新触发器

  • 架构更改:重大结构决策
  • 功能完成:新特性或功能
  • 漏洞修补:重大问题解决
  • 重构:代码结构改进
  • 决策:任何重要的技术选择
  • 进度更新:任务状态更改

工具参考

init内存库

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

参数:

  • rootPath:项目根目录路径
  • force (可选):强制重新初始化

退货: 已创建文件列表和下一步指南

获取存储体信息

读取并返回所有内存库内容(类似于codelf的获取项目信息)。

参数:

  • rootPath:项目根目录路径

退货: 用于AI上下文的格式化内存库内容

更新内存库

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

参数:

  • rootPath:项目根目录路径
  • changeType:更改类型(架构/功能/错误修复/重构/决策/进度)
  • description:变更简要说明

退货: 带有模板和时间戳的详细更新说明

集成提示

光标设置

添加到设置→ 规则→ 用户规则:

Before starting any task, check if memory-bank directory exists in the project. If not, run the MCP command init-memory-bank.
Use the MCP command get-memory-bank-info to read Memory Bank content at session start.
After completing tasks or conversations, you must use the MCP command update-memory-bank to update Memory Bank content.
Follow the MCP guidance to maintain Memory Bank files.

风帆设置

添加到设置→ 级联→ 记忆与规则→ 全球规则:

Before starting any task, check if memory-bank directory exists in the project. If not, run the MCP command init-memory-bank.
Use the MCP command get-memory-bank-info to read Memory Bank content at session start.
After completing tasks or conversations, you must use the MCP command update-memory-bank to update Memory Bank content.
Follow the MCP guidance to maintain Memory Bank files.

贡献

欢迎投稿!请随时提交问题或拉取请求。

许可证

麻省理工学院

致谢

受到SPARC方法和代码的启发。