Memory Bank MCP

<div align="center"> <img src="https://raw.githubusercontent.com/modelcontextprotocol/mcp/main/icon.png" height="128"> <h1>Memory Bank MCP</h1> <p> <b>一个通过模型上下文协议 (MCP) 实现项目知识管理的结构化文档系统</b> </p> </div>

Memory Bank 是一个 MCP 服务器，旨在帮助团队创建、管理和访问结构化的项目文档。它生成并维护一组相互连接的 Markdown 文档，这些文档捕获项目知识的各个方面，从高层目标到技术细节和日常进展。

特性

• AI 生成文档: 利用 Gemini API 自动生成全面的项目文档
• 结构化知识系统: 以分层结构维护六种核心文档类型
• MCP 集成: 实施模型上下文协议，以便与 AI 助手无缝集成
• 可自定义位置: 指定您希望创建 Memory Bank 目录的位置
• 文档模板: 预定义的项目简报、产品背景、系统模式等模板。
• AI 辅助更新: 手动更新文档或在 AI 辅助下重新生成文档
• 高级查询: 在所有文档中进行搜索，并具有上下文相关的相关性排序

安装

# 克隆仓库
git clone https://github.com/yourusername/memory-bank-mcp.git
cd memory-bank-mcp

# 安装依赖
npm install

# 创建包含您的 Gemini API 密钥的 .env 文件（可选）
echo "GEMINI_API_KEY=your_api_key_here" > .env

使用

开发模式

# 以开发模式启动
npm run dev

生产模式

# 构建项目
npm run build

# 以生产模式启动
npm run start

MCP 配置

要将 Memory Bank 与模型上下文协议 (MCP) 集成，请将以下配置添加到您的 mcp.json 文件：

{
  "memoryBank": {
    "command": "node",
    "args": ["/path/to/memory-bank-mcp/dist/index.js"],
    "env": {
      "GEMINI_API_KEY": "your_gemini_api_key_here"
    }
  }
}

将 /path/to/memory-bank-mcp/dist/index.js 替换为您构建的 index.js 文件的绝对路径，并添加您的 Gemini API 密钥（如果适用）。

示例：

{
  "memoryBank": {
    "command": "node",
    "args": ["/Users/username/memory-bank-mcp/dist/index.js"],
    "env": {
      "GEMINI_API_KEY": "AIzaSyXXXXXXXXXXXXXXXXXXXXXXXX"
    }
  }
}

MCP 工具

Memory Bank MCP 通过模型上下文协议提供以下工具：

initialize_memory_bank

创建一个新的 Memory Bank 结构，其中包含所有文档模板。

参数：

• goal (string): 项目目标描述（最少 10 个字符）
• geminiApiKey (string, optional): 用于文档生成的 Gemini API 密钥
• location (string, optional): 将创建 memory-bank 文件夹的绝对路径

示例：

await callTool({
  name: "initialize_memory_bank",
  arguments: {
    goal: "Building a self-documenting AI-powered software development assistant",
    location: "/Users/username/Documents/projects/ai-assistant"
  }
});

update_document

更新 Memory Bank 中的特定文档。

参数：

• documentType (enum): 以下之一：projectbrief、productContext、systemPatterns、techContext、activeContext、progress
• content (string, optional): 文档的新内容
• regenerate (boolean, default: false): 是否使用 AI 重新生成文档

示例：

await callTool({
  name: "update_document",
  arguments: {
    documentType: "projectbrief",
    content: "# Project Brief\n\n## Purpose\nTo develop an advanced and user-friendly AI..."
  }
});

query_memory_bank

在所有文档中进行搜索，并具有上下文相关的相关性排序。

参数：

• query (string): 搜索查询（最少 5 个字符）

示例：

await callTool({
  name: "query_memory_bank",
  arguments: {
    query: "system architecture components"
  }
});

export_memory_bank

导出所有 Memory Bank 文档。

参数：

• format (enum, default: "folder"): 导出格式，可以是 "json" 或 "folder"
• outputPath (string, optional): 导出的自定义输出路径

示例：

await callTool({
  name: "export_memory_bank",
  arguments: {
    format: "json",
    outputPath: "/Users/username/Documents/exports"
  }
});

文档类型

Memory Bank 将项目知识组织成六种核心文档类型：

1. 项目简报 (projectbrief.md): 定义项目目标、范围和愿景的核心文档
2. 产品背景 (productContext.md): 从用户角度记录产品功能
3. 系统模式 (systemPatterns.md): 建立系统架构和组件关系
4. 技术背景 (techContext.md): 指定技术栈和实现细节
5. 活动背景 (activeContext.md): 跟踪当前任务、未解决的问题和开发重点
6. 进度 (progress.md): 记录已完成的工作、里程碑和项目历史

许可证

MIT