记忆库MCP服务器

这是一个用于远程记忆库管理的模型上下文协议（MCP）服务器实现，灵感来源于Cline记忆库。

概述

记忆库MCP服务器将传统的基于文件的记忆库转换为集中式服务，提供以下功能：

• 通过MCP协议远程访问记忆库文件
• 支持多项目记忆库管理
• 维护一致的文件结构和验证
• 确保项目记忆库之间的适当隔离

功能

• 多项目支持

  • 项目特定目录
  • 文件结构强制
  • 路径遍历预防
  • 项目列表功能
  • 按项目列出文件

• 远程访问

  • 完整的MCP协议实现
  • 类型安全操作
  • 适当的错误处理
  • 通过项目隔离实现安全性

• 核心操作

  • 读取/写入/更新记忆库文件
  • 列出可用项目
  • 列出项目中的文件
  • 项目存在验证
  • 安全的只读操作

安装

通过Smithery自动为Claude桌面版安装记忆库服务器：

npx -y @smithery/cli install @alioshr/memory-bank-mcp --client claude

这将自动设置MCP服务器配置。或者，您可以按照下面的配置部分手动配置服务器。

快速开始

1. 在设置中配置MCP服务器（见下面的配置部分）
2. 开始在您的AI助手中使用记忆库工具

配置

记忆库MCP服务器需要在您的Cline MCP设置文件中进行配置。位置取决于您的设置：

• 对于Cline扩展：~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
• 对于Roo Code VS Code扩展：~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/mcp_settings.json
• 对于Claude桌面应用：~/Library/Application Support/Claude/claude_desktop_config.json

将以下配置添加到您的MCP设置中：

{
  "allpepper-memory-bank": {
    "command": "npx",
    "args": ["-y", "@allpepper/memory-bank-mcp"],
    "env": {
      "MEMORY_BANK_ROOT": "<path-to-bank>"
    },
    "disabled": false,
    "autoApprove": [
      "memory_bank_read",
      "memory_bank_write",
      "memory_bank_update",
      "list_projects",
      "list_project_files"
    ]
  }
}

配置详情

• MEMORY_BANK_ROOT: 项目记忆库存储的目录（例如，/path/to/memory-bank）
• disabled: 设置为false以启用服务器
• autoApprove: 不需要明确用户批准的操作列表：
  • memory_bank_read: 读取记忆库文件
  • memory_bank_write: 创建新的记忆库文件
  • memory_bank_update: 更新现有的记忆库文件
  • list_projects: 列出可用项目
  • list_project_files: 列出项目中的文件

对于Cursor

对于Cursor，打开设置 -> 功能 -> 添加MCP服务器 -> 添加以下内容：

env MEMORY_BANK_ROOT=<path-to-bank> npx -y @allpepper/memory-bank-mcp@latest

自定义AI指令

本节包含应粘贴在AI自定义指令中的指令，适用于Cline、Claude或Cursor，或任何其他MCP客户端。您应复制并粘贴这些规则。有关参考，请参阅custom-instructions.md，其中包含这些规则。

开发

基本开发命令：

# 安装依赖
npm install

# 构建项目
npm run build

# 运行测试
npm run test

# 在监视模式下运行测试
npm run test:watch

# 使用ts-node直接运行服务器以进行快速测试
npm run dev

使用Docker运行

1. 构建Docker镜像：

   docker build -t memory-bank-mcp:local .
   

2. 运行Docker容器进行测试：

   docker run -i --rm \
     -e MEMORY_BANK_ROOT="/mnt/memory_bank" \
     -v /path/to/memory-bank:/mnt/memory_bank \
     --entrypoint /bin/sh \
     memory-bank-mcp:local \
     -c "ls -la /mnt/memory_bank"
   

3. 添加MCP配置，例如Roo Code：

   "allpepper-memory-bank": {
     "command": "docker",
     "args": [
       "run", "-i", "--rm",
       "-e", 
       "MEMORY_BANK_ROOT",
       "-v", 
       "/path/to/memory-bank:/mnt/memory_bank",
       "memory-bank-mcp:local"
     ],
     "env": {
       "MEMORY_BANK_ROOT": "/mnt/memory_bank"
     },
     "disabled": false,
     "alwaysAllow": [
       "list_projects",
       "list_project_files",
       "memory_bank_read",
       "memory_bank_update",
       "memory_bank_write"
     ]
   }
   

贡献

欢迎贡献！请遵循以下步骤：

1. 分叉仓库
2. 创建一个特性分支（git checkout -b feature/amazing-feature）
3. 提交您的更改（git commit -m 'Add amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打开一个拉取请求

开发指南

• 对所有新代码使用TypeScript
• 在整个代码库中维护类型安全
• 为新特性添加测试
• 根据需要更新文档
• 遵循现有的代码风格和模式

测试

• 为新特性编写单元测试
• 包括多项目场景测试
• 彻底测试错误情况
• 验证类型约束
• 适当模拟文件系统操作

许可证

本项目在MIT许可证下授权 - 有关详细信息，请参阅LICENSE文件。

致谢

本项目实现了最初在Cline记忆库中记录的记忆库概念，并通过远程功能和多项目支持进行了扩展。