使用说明

项目简介

Memory Bank MCP Server 2.0 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为 LLM 应用提供项目文档和上下文管理能力。它受到 Cline Memory Bank 的启发,用于帮助 Claude 等 LLM 维护一致的项目知识。

主要功能点

  • 资源管理: 托管和管理全局和分支级别的 Memory Bank,存储项目文档和上下文信息。
  • 数据访问: 提供 API 工具,允许 LLM 客户端读取和写入 Memory Bank 中的文档。
  • 工具执行: 注册和执行工具,例如 'read_context' 用于获取项目上下文,'write_branch_memory_bank' 用于写入分支 Memory Bank。
  • Prompt 模板: 虽然没有显式提到 Prompt 模板,但通过 'read_rules' 工具和提供的 System Prompt 示例,暗示了对 Prompt 定制和管理的支持。
  • JSON-RPC 通信: 通过 JSON-RPC 协议与客户端通信,使用 Stdio 传输协议。

安装步骤

  • NPX (推荐): 在终端中运行 'npx memory-bank-mcp-server' 即可启动服务器。

  • 全局安装 (可选): 使用 'npm install -g memory-bank-mcp-server' 全局安装后,运行 'memory-bank-mcp-server' 启动服务器。

服务器配置

  • 对于 MCP 客户端(如 Claude Desktop),需要在配置文件 'claude_desktop_config.json' 中添加 MCP 服务器配置。
{
  "mcpServers": {
    "memory-bank": {
      "command": "npx",
      "args": ["-y", "memory-bank-mcp-server"],
      "env": {
        "MEMORY_BANK_ROOT": "/path/to/docs", // (可选) 文档根目录路径,默认为 './docs'
        "MEMORY_BANK_LANGUAGE": "ja" // (可选) 模板语言,默认为 'en',可选 'en', 'ja', 'zh'
      }
    }
  }
}

或全局安装方式:

{
  "mcpServers": {
    "memory-bank": {
      "command": "memory-bank-mcp-server",
      "env": {
        "MEMORY_BANK_ROOT": "/path/to/docs", // (可选) 文档根目录路径,默认为 './docs'
        "MEMORY_BANK_LANGUAGE": "ja" // (可选) 模板语言,默认为 'en',可选 'en', 'ja', 'zh'
      }
    }
  }
}

基本使用方法

  • 服务器启动后,MCP 客户端可以通过配置的服务器名称 "memory-bank" 与之连接。
  • 客户端可以使用 MCP 协议定义的工具,如 'list_tools' 查看可用工具,'read_context' 获取项目上下文信息,'write_branch_memory_bank' 更新分支 Memory Bank 等。
  • 具体工具的使用方法和参数,请参考仓库 README.md 的 API 部分。

信息

分类

生产力应用