article
README
🚀 内存银行 MCP 服务器
本项目是一个内存银行实现,主要用于管理项目文档和技术背景,确保其在不同会话间保持一致。借助模型上下文协议(MCP),该服务器能帮助 AI 代理(如 Claude)维持跨项目的知识一致性。相关知识以全局和分支特定的内存银行形式存在,采用结构化的 JSON 格式进行存储。
项目灵感源自 Cline Memory Bank,来自 nickbaumann98/cline_docs 仓库。
🚀 快速开始
先决条件
- Node.js(可参考
.tool-versions以使用推荐版本) - Yarn(v1.x)
安装
从仓库根目录克隆项目并安装依赖:
git clone https://github.com/t3ta/memory-bank-mcp-server.git
cd memory-bank-mcp-server
yarn install
运行 MCP 服务器
可直接在单仓库管理中运行 MCP 服务器:
# 在单仓库管理根目录下执行
yarn workspace @memory-bank/mcp start --docs /path/to/your/docs
请将 /path/to/your/docs 替换为实际的项目文档路径,global-memory-bank 和 branch-memory-bank 文件或文件夹将在此处创建或已存在。
更多关于运行服务器和选项的信息,请参阅 packages/mcp/README.md。
✨ 主要特性
- 借助 MCP 协议,助力 AI 代理维护跨项目的知识一致性。
- 以结构化 JSON 格式存储知识,便于管理和使用。
- 采用单仓库管理(monorepo),使用 Yarn 工作区进行管理,结构清晰。
📦 安装指南
安装依赖
git clone https://github.com/t3ta/memory-bank-mcp-server.git
cd memory-bank-mcp-server
yarn install
运行服务器
yarn workspace @memory-bank/mcp start --docs /path/to/your/docs
📚 详细文档
包结构
此仓库采用单仓库管理(monorepo),使用 Yarn 工作区管理,包含以下包:
packages/mcp:MCP 服务器的核心实现,涵盖处理内存银行操作、MCP 工具执行和服务器启动的主要逻辑。packages/schemas:定义用于内存银行文档(如memory_document_v2)的 JSON 模式。packages/vscode-extension:一个 VSCode 扩展,可实现与内存银行 MCP 服务器的集成(详细信息待定)。
开发相关
- 构建所有包:
yarn build - 为所有包运行测试:
yarn test - 检查代码:
yarn lint
如需更多特定于包的开发说明,请参考每个包目录中的 README 文件。
📄 许可证
本项目采用 MIT 许可证,详细信息请参阅 LICENSE 文件。
扫码联系在线客服