项目简介
a24z-Memory 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在作为您代码库的“活记忆”。它通过将团队积累的知识(如架构决策、最佳实践、常见陷阱)直接锚定到代码文件,并以结构化的方式(如 CodebaseViews、Notes、Tags 和 Anchors)存储这些信息。AI 助手可以通过 MCP 协议访问这些知识,从而提供更准确、上下文更丰富的代码理解和开发协助。
主要功能点
- 空间知识图谱 (CodebaseViews):将代码库组织成可导航的网格视图,帮助 AI 理解代码结构和文件之间的空间关系。
- 锚定知识 (Anchored Notes):将重要的见解、决策或经验(Notes)直接关联到特定的代码文件或目录(Anchors),确保知识与代码同步演进。
- 标签与描述 (Tags & Descriptions):通过语义标签对知识进行分类,支持更高效的检索和过滤。
- 知识演进 (Git Distribution):所有知识都存储在 '.a24z' 目录中,并通过 Git 进行版本控制和团队共享,确保知识的时效性。
- AI 辅助:为 AI 助手提供上下文感知响应,帮助其避免已知陷阱、遵循既定模式并加速新成员的上手过程。
- 工具集:提供一系列 MCP 工具,允许 LLM 客户端创建、检索、删除、更新笔记和标签,以及分析代码覆盖率和视图列表。
安装步骤
- 环境要求: 确保您的系统已安装 Node.js 18+ 和 Git。
- 全局安装 (推荐): 在终端中运行以下命令进行全局安装。
npm install -g a24z-memory - 项目内安装: 如果您希望将其作为项目依赖安装,可运行:
npm install a24z-memory --save-dev - 验证安装: 运行以下命令检查是否安装成功并查看帮助信息。
npx a24z-memory --help - 启动服务器: 在您的代码仓库根目录(包含 '.git' 文件夹的目录)下,保持以下命令在终端中运行以启动 MCP 服务器。服务器将监听标准输入/输出 (stdio)。
成功启动后,您将看到类似 '✅ a24z-Memory MCP server started successfully' 的输出。npx a24z-memory start
MCP客户端配置
为了让您的MCP客户端(如Cursor、VS Code等)连接并使用 a24z-Memory 服务器,您需要在客户端的配置中添加服务器的启动命令。通常这是一个JSON格式的配置项。以下是一个示例配置,您应根据客户端的文档进行调整:
{ "mcpServers": { "a24z-memory": { "command": "npx", "args": ["-y", "a24z-memory"] } } }
- 'mcpServers': 客户端用于配置所有MCP服务器的主键。
- 'a24z-memory': 您为该MCP服务器定义的名称,客户端将使用此名称来引用服务器。
- 'command': 启动服务器所需的命令,通常是 'npx' 或 'node'。
- 'args': 传递给 'command' 的参数列表,'-y a24z-memory' 表示运行全局安装的 'a24z-memory' 包。
请查阅您的MCP客户端(如Cursor、VS Code、Claude Code等)的 MCP 服务器配置文档,以获取准确的配置方式。
基本使用方法
一旦服务器启动并在客户端中配置完成,您的AI助手将获得一套强大的工具来管理代码库知识。
- 发现可用工具: 向AI助手提问:“a24z-Memory有哪些工具可用?”
- 创建代码库笔记: 指导AI助手:“为 'src/auth/jwt.ts' 文件创建一个关于JWT认证模式的笔记,标签为 'authentication' 和 'pattern'。” (AI助手将调用 'create_repository_note' 工具)
- 查询代码库知识: 向AI助手提问:“在 'src/services' 目录下,有什么关于性能优化的知识?” (AI助手将调用 'get_notes' 或 'askA24zMemory' 工具)
- 管理标签: 向AI助手提问:“查看仓库中所有使用的标签及其描述。” (AI助手将调用 'get_repository_tags' 工具) 向AI助手提问:“删除名为 'bug-fix' 的标签及其相关笔记引用。” (AI助手将调用 'delete_tag' 工具)
信息
分类
开发者工具