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的啟發。