Memory Bank MCP

Memory Bank MCP

site icon
2025.04.17 4
TypeScript项目知识管理结构化文档系统开发效率交流协作
Memory Bank MCP 是一个基于模型上下文协议(MCP)的结构化文档系统,旨在帮助团队创建、管理和访问项目知识。它通过生成和维护一组相互关联的Markdown文档,捕捉项目知识的各个方面,从高层次目标到技术细节和日常进展。
View on GitHub

Overview

基本能力

产品定位

Memory Bank MCP 是一个用于项目知识管理的结构化文档系统,通过模型上下文协议(MCP)实现与AI助手的无缝集成。

核心功能

  • AI生成的文档:利用Gemini API自动生成全面的项目文档。
  • 结构化知识系统:维护六种核心文档类型的层次结构。
  • MCP集成:实现模型上下文协议,与AI助手无缝集成。
  • 可定制位置:指定Memory Bank目录的创建位置。
  • 文档模板:预定义的模板,包括项目简介、产品上下文、系统模式等。
  • AI辅助更新:手动更新文档或通过AI辅助重新生成。
  • 高级查询:在所有文档中进行上下文感知的相关性排名搜索。

适用场景

  • 团队项目知识管理
  • AI辅助的项目文档生成和维护
  • 结构化文档系统的创建和管理

工具列表

  • initialize_memory_bank:创建新的Memory Bank结构,包含所有文档模板。
  • update_document:更新Memory Bank中的特定文档。
  • query_memory_bank:在所有文档中进行上下文感知的相关性排名搜索。
  • export_memory_bank:导出所有Memory Bank文档。

常见问题解答

  • 如何集成Gemini API?在.env文件中设置GEMINI_API_KEY。
  • 如何启动开发模式?运行npm run dev
  • 如何启动生产模式?运行npm run buildnpm run start

使用教程

使用依赖

# Clone the repository
git clone https://github.com/yourusername/memory-bank-mcp.git
cd memory-bank-mcp

# Install dependencies
npm install

# Create .env file with your Gemini API key (optional)
echo "GEMINI_API_KEY=your_api_key_here" > .env

安装教程

# Start in development mode
npm run dev

# Build the project
npm run build

# Start in production mode
npm run start

调试方式

# Start in development mode
npm run dev

MCP Configuration

To integrate Memory Bank with the Model Context Protocol (MCP), add the following configuration to your mcp.json file:

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

许可证

该项目遵循 MIT 开源许可条款。