article
README
🚀 记忆银行 MCP
记忆银行 MCP 是基于模型上下文协议(MCP)的项目知识管理系统,它能够实现文档的结构化记录与管理,助力团队高效创建、管理和访问结构化的项目文档。
🚀 快速开始
记忆银行是一个 MCP 服务器,帮助团队创建、管理和访问结构化的项目文档。它通过生成和维护一组相互关联的 Markdown 文档,捕捉项目知识的不同方面,从高层次目标到技术细节再到日常进展。
✨ 主要特性
- AI 自动生成文档:利用 Gemini API 自动生成全面的项目文档
- 结构化知识体系:维护六个核心文档类型的层级结构
- MCP 集成:实现模型上下文协议,与 AI 助手无缝集成
- 自定义位置:指定创建记忆银行目录的位置
- 文档模板:提供现成的模板,包括项目简报、产品背景、系统模式等
- AI 辅助更新:手动更新文档或通过 AI 重新生成
- 高级查询:在所有文档中进行上下文感知的相关性搜索
📦 安装指南
# 克隆仓库
git clone https://github.com/tuncer-byte/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 配置
记忆银行通过以下 JSON 文件配置:
{
"memoryBank": {
"api_key": "your_api_key_here",
"context_size": 1024,
"temperature": 0.7
}
}
📚 详细文档
记忆银行将项目知识组织为六个核心文档类型:
- 项目简报 (
projectbrief.md):定义项目目标、范围和愿景的核心文件 - 产品背景 (
productContext.md):从用户角度记录产品的功能和价值 - 系统模式 (
systemPatterns.md):建立系统的架构和组件关系 - 技术背景 (
techContext.md):指定技术栈和实现细节 - 活动背景 (
activeContext.md):跟踪当前任务、未解决问题和开发重点 - 进展记录 (
progress.md):记录已完成的工作、里程碑和项目历史
📄 许可证
MIT
微信扫一扫