注意: 这不是一个传统的Node.js应用程序。内存银行MCP是一个MCP服务器——它是模型上下文协议生态系统中的一个组件。它使用标准化的协议向LLM驱动的代理和工具提供项目知识,从而实现与AI客户端(如Claude Desktop、IDE或自定义LLM代理)的无缝集成。
MCP是一种开放协议,用于标准化应用程序如何向LLMs提供上下文。可以将MCP想象成AI的USB-C端口:它提供了一种通用的方式来连接AI模型到数据源和工具,无论是本地还是远程。MCP使以下成为可能:
了解更多:MCP介绍
内存银行MCP是一个MCP服务器,帮助团队创建、管理和访问结构化的项目文档。它生成并维护相互关联的Markdown文档,捕捉项目知识的所有方面,从高层次目标到技术细节和日常进展。它设计为由兼容MCP的客户端和LLM代理访问。
# 克隆仓库
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
注意: 内存银行MCP旨在作为MCP服务器运行,而不是独立应用。通常将其作为MCP工作流程的一部分启动,并从兼容MCP的客户端(如Claude Desktop或自己的LLM代理)连接到它。
npm run dev
npm run build
npm run start
要将内存银行MCP连接到你的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替换为你构建文件的绝对路径,并根据需要添加你的Gemini API密钥。
内存银行MCP通过模型上下文协议提供了以下工具:
initialize_memory_bank创建一个新的内存银行结构,包括所有文档模板。
参数:
goal(字符串):项目目标描述(至少10个字符)geminiApiKey(字符串,可选):用于文档生成的Gemini API密钥location(字符串,可选):内存银行文件夹将被创建的绝对路径示例:
await callTool({
name: "initialize_memory_bank",
arguments: {
goal: "构建一个自我记录的AI驱动的软件开发助手",
location: "/Users/username/Documents/projects/ai-assistant"
}
});
update_document更新内存银行中的特定文档。
参数:
documentType(枚举):其中之一:projectbrief、productContext、systemPatterns、techContext、activeContext、progresscontent(字符串,可选):文档的新内容regenerate(布尔,默认:false):是否使用AI重新生成文档示例:
await callTool({
name: "update_document",
arguments: {
documentType: "projectbrief",
content: "# 项目简介\n\n## 目的\n开发一个先进且用户友好的AI..."
}
});
query_memory_bank根据相关性排名跨所有文档搜索。
参数:
query(字符串):搜索查询(至少5个字符)示例:
await callTool({
name: "query_memory_bank",
arguments: {
query: "系统架构组件"
}
});
export_memory_bank导出所有内存银行文档。
参数:
format(枚举,默认:“folder”):导出格式,要么“json”要么“folder”outputPath(字符串,可选):导出的自定义输出路径示例:
await callTool({
name: "export_memory_bank",
arguments: {
format: "json",
outputPath: "/Users/username/Documents/exports"
}
});
内存银行将项目知识组织成六种核心文档类型:
projectbrief.md):定义项目目标、范围和愿景的核心文档productContext.md):从用户角度记录产品的功能systemPatterns.md):建立系统架构和组件关系techContext.md):指定技术栈和实施细节activeContext.md):跟踪当前任务、开放问题和开发重点progress.md):记录已完成的工作、里程碑和项目历史MIT