项目简介

Memory Bank MCP 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为 AI 助手提供结构化的 记忆库 (Memory Bank) 管理能力。通过 Memory Bank,AI 助手可以在不同会话间存储和检索信息,从而实现上下文的持久化和应用状态的维护。该服务器提供了一系列工具和资源,使得 AI 助手能够有效地与 Memory Bank 交互,进行数据访问、功能调用和 Prompt 定制。

主要功能点

  • 记忆库管理: 支持初始化、查找和管理记忆库,方便 AI 助手进行上下文存储和检索。
  • 文件操作: 允许 AI 助手在记忆库中读写文件,实现信息持久化。
  • 进度追踪: 记录项目进展和更新记忆库文件,帮助 AI 助手跟踪工作状态。
  • 决策日志: 记录重要的决策及其背景信息,方便回顾和审计。
  • 活跃上下文管理: 维护和更新当前会话的上下文信息,确保 AI 助手理解当前语境。
  • 多模式支持: 支持代码、架构、提问、调试和测试等多种操作模式,优化不同任务下的 AI 交互。
  • UMB 命令: 允许在会话中临时更新记忆库文件,无需立即提交更改。
  • 状态前缀系统: 通过状态前缀清晰展示记忆库的运行状态(激活、未激活、更新中)。

安装步骤

  1. 使用 npm 安装 (推荐):

    npm install @movibe/memory-bank-mcp

    或者全局安装:

    npm install -g @movibe/memory-bank-mcp

    或者使用 npx 直接运行(无需安装):

    npx @movibe/memory-bank-mcp

服务器配置

MCP 服务器需要配置在 MCP 客户端中才能使用。以 Cursor 编辑器为例,配置 Memory Bank MCP 服务器的步骤如下:

  1. 打开 Cursor 设置 (⚙️) > 扩展 > MCP。

  2. 点击 "Add MCP Server" (添加 MCP 服务器)。

  3. 填写以下服务器配置信息:

    {
      "serverName": "Memory Bank MCP",  // 服务器名称,自定义,方便在客户端中识别
      "command": "npx",                 // 启动服务器的命令,通常为 npx 或 node
      "args": [                         // 命令参数,用于指定执行的包和选项
        "@movibe/memory-bank-mcp",    // 要执行的 npm 包名
        "--mode", "code"             // (可选) 运行模式,例如 "code", "architect", "ask" 等,默认为 "code"。根据需要选择合适的模式
        // "--path", "/path/to/project" // (可选) 项目路径,默认为当前工作目录。如果需要指定项目路径,请取消注释并修改为实际路径
        // "--folder", "custom-memory"  // (可选) 记忆库文件夹名称,默认为 "memory-bank"。如果需要自定义文件夹名称,请取消注释并修改
        // "--githubProfileUrl", "https://github.com/your-username" // (可选) GitHub 个人资料 URL,用于跟踪更改的作者。如果需要启用用户跟踪,请取消注释并修改为实际 URL
        // "--debug"                     // (可选) 启用调试模式,显示详细日志。如果需要查看详细日志,请取消注释
      ]
    }

    参数说明:

    • serverName: MCP 服务器的名称,您可以自定义设置,用于在客户端中区分不同的 MCP 服务器配置。
    • command: 运行命令,通常设置为 'npx' 或 'node'。如果全局安装,也可以直接使用 'memory-bank-mcp' 作为 command,并移除 'args' 中的 '@movibe/memory-bank-mcp'。
    • args: 命令参数,以数组形式提供,用于配置 Memory Bank MCP 服务器的行为。常用的参数包括:
      • '@movibe/memory-bank-mcp': 指定要执行的 npm 包名称,即 Memory Bank MCP 服务器。
      • '--mode <mode>': 设置服务器的运行模式,可选值包括 'code', 'architect', 'ask', 'debug', 'test'。不同的模式会影响服务器的行为和 Prompt 模板。
      • '--path <project_path>': 指定项目路径。Memory Bank 将在该路径下创建或访问 'memory-bank' 文件夹。默认为当前工作目录。
      • '--folder <folder_name>': 自定义 Memory Bank 文件夹的名称。默认为 'memory-bank'。
      • '--githubProfileUrl <github_url>': GitHub 个人资料 URL,用于在 Memory Bank 的记录中标记操作的用户。
      • '--debug': 启用调试模式,服务器会输出更详细的日志信息。
      • '--help': 显示帮助信息。
  4. 点击 "Save" (保存)。

  5. 启用刚刚添加的 "Memory Bank MCP" 服务器。

基本使用方法

成功配置并启用 Memory Bank MCP 服务器后,您可以在 MCP 客户端(如 Cursor 编辑器)中使用 '/mcp' 命令与其交互。以下是一些基本的使用示例:

  • 初始化记忆库:

    /mcp memory-bank-mcp initialize_memory_bank path=./memory-bank
  • 追踪进度:

    /mcp memory-bank-mcp track_progress action="Feature Implementation" description="Implemented feature X"
  • 记录决策:

    /mcp memory-bank-mcp log_decision title="API Design" context="..." decision="..."
  • 切换模式:

    /mcp memory-bank-mcp switch_mode mode=code

更多使用方法和详细信息,请参考仓库的 README.md 文件和文档。

信息

分类

AI与计算