article
README
🚀 内存银行 MCP
内存银行 MCP 是一个基于模型上下文协议 (MCP) 的项目知识管理系统,主要用于结构化文档记录。它能帮助团队高效创建、管理和访问结构化的项目文档,将项目知识的各个方面,从高层次目标到技术细节,再到日常进展,都清晰地记录下来。
🚀 快速开始
内存银行是一个 MCP 服务器,可助力团队创建、管理和访问结构化的项目文档。它通过生成和维护一系列相互关联的 Markdown 文件,来记录项目知识的不同方面。
✨ 主要特性
- AI 自动生成文档:利用双子星 API 自动生成全面的项目文档
- 结构化知识系统:维护六个核心文档类型,在层次结构中组织知识
- MCP 集成:实现模型上下文协议,与 AI 助手无缝集成
- 自定义位置:指定创建内存银行目录的位置
- 文档模板:预定义的模板用于项目简报、产品上下文、系统模式等
- AI 辅助更新:手动或通过 AI 协助更新文档
- 高级查询:在所有文档中搜索,带上下文感知的相关性排序
📦 安装指南
# 克隆仓库
git clone https://github.com/tuncer-byte/memory-bank-mcp.git
cd memory-bank-mcp
# 安装依赖项
npm install
# 创建 .env 文件并添加双子星 API 密钥(可选)
echo "GEMINI_API_KEY=your_api_key_here" > .env
💻 使用示例
基础用法
开发模式
# 在开发模式下启动
npm run dev
生产模式
# 构建项目
npm run build
# 在生产模式下启动
npm run start
📚 详细文档
MCP 配置
内存银行通过以下配置与 MCP 交互:
{
"servers": {
"@tuncer-byte/memory-bank-MCP": {
"url": "https://glama.ai/mcp/servers/@tuncer-byte/memory-bank-MCP"
}
}
}
提供的工具
内存银行提供以下功能:
- 创建文档:生成结构化的项目文档
- 更新内容:实时编辑和维护文档
- 导出数据:以 JSON 或文件夹格式导出内容
- 查询信息:搜索项目相关知识
文档类型
内存银行将项目知识组织为六种核心文档类型:
- 项目简报 (
projectbrief.md):定义项目目标、范围和愿景的核心文件 - 产品上下文 (
productContext.md):从用户角度记录产品功能 - 系统模式 (
systemPatterns.md):建立系统架构和组件关系 - 技术上下文 (
techContext.md):指定技术栈和实现细节 - 活跃上下文 (
activeContext.md):跟踪当前任务、未解决问题和开发重点 - 进展记录 (
progress.md):记录完成的工作、里程碑和项目历史
📄 许可证
本项目采用 MIT 许可证。
Scan to contact