AI Memory
AI Memory 使用说明
项目简介
AI Memory 是一款 VSCode 扩展,旨在通过 Memory Bank 技术帮助开发者更有效地管理 AI 项目的上下文信息。它集成了 模型上下文协议 (MCP),充当 MCP 服务器,为支持 MCP 协议的 LLM 客户端(如 Cursor AI)提供结构化的上下文服务。通过 AI Memory,您可以轻松地组织和访问项目相关的各种文档和信息,确保 LLM 在对话过程中拥有充分的上下文,从而提升代码生成、问题解答等 AI 辅助任务的质量和效率。
主要功能点
- 资源 (Resources) 管理: 以文件形式 (Memory Bank Files) 托管和管理项目上下文信息,包括项目简述、产品背景、当前工作重点、系统模式、技术背景和项目进度等,并通过 'memory-bank://' URI 提供标准化的数据访问能力。
- 工具 (Tools) 注册与执行: 内置 'initialize-memory-bank'、'read-memory-bank-files'、'list-memory-bank-files' 等工具,允许 LLM 客户端调用以初始化内存库、读取文件列表等操作,扩展 LLM 的功能边界。
- Prompt 模板 (Prompts) 定义: 预置 'memory-bank-guide' 和 'memory-command-processor' 等 Prompt 模板,为 LLM 客户端提供可定制的交互模式,优化针对 Memory Bank 的指令和查询。
- Cursor AI 集成: 自动配置 Cursor AI 的 MCP 集成设置,实现无缝连接,即装即用。同时提供手动更新 Cursor MCP 配置的命令,方便用户管理连接。
- 健康检查和状态监控: 提供 '/health' 和 '/status' 端点,方便用户检查 MCP 服务器的运行状态和连接信息。
- 多种传输协议支持: 通过 SSE (Server-Sent Events) 协议与 MCP 客户端通信,保证实时性和效率。
- 用户友好的 VSCode 界面: 提供 Webview 界面,方便用户查看和管理 AI Memory 的状态,以及进行规则重置等操作。
安装步骤
- 在 VSCode 扩展商店中搜索 "AI Memory" 并安装。
- 在您的项目工作区根目录下创建一个名为 'memory-bank' 的文件夹。
- 在 VSCode 命令面板 (Command Palette, 'Ctrl+Shift+P' 或 'Cmd+Shift+P') 中运行命令 'AI Memory: Start MCP' 启动 MCP 服务器。默认服务器端口为 '7331',如果端口被占用,会自动尝试 '7332' 端口。
服务器配置
AI Memory MCP 服务器主要服务于 MCP 客户端,例如 Cursor AI。安装并启动 AI Memory 扩展后,通常无需手动配置客户端,因为扩展会自动更新 Cursor 的 MCP 配置。
如果您需要手动配置 MCP 客户端(例如 Cursor AI),您需要提供以下服务器信息:
{ "serverName": "AI Memory", // 服务器名称,可自定义 "command": "", // 启动服务器的命令,AI Memory 扩展作为 VSCode 扩展运行,无需外部命令 "args": [], // 启动参数,AI Memory 扩展无需启动参数 "url": "http://localhost:7331/sse" // MCP 服务器的 SSE 端点 URL,默认为 http://localhost:7331/sse,如果启动时使用了 7332 端口,请相应修改为 http://localhost:7332/sse }
Cursor AI 客户端配置说明 (通常由 AI Memory 扩展自动完成):
Cursor AI 需要配置 'mcpServers' 才能连接到 AI Memory MCP 服务器。配置信息通常位于 '~/.cursor/mcp.json' 文件中。AI Memory 扩展在启动时会自动尝试更新此配置文件。您也可以手动运行 'AI Memory: Update Cursor MCP Config' 命令来更新 Cursor 的 MCP 配置。
基本使用方法
- 启动 MCP 服务器: 安装并激活 AI Memory 扩展后,在 VSCode 命令面板中运行 'AI Memory: Start MCP' 命令启动服务器。
- 连接 Cursor AI (自动): 如果您的 MCP 客户端是 Cursor AI,AI Memory 扩展会自动配置 Cursor 连接到 MCP 服务器。您无需手动操作,即可在 Cursor 中使用 AI Memory 提供的上下文服务。
- 使用 Memory Bank: 在 'memory-bank' 文件夹中编辑 Markdown 文件(如 'projectbrief.md', 'activeContext.md' 等),更新项目上下文信息。LLM 客户端可以通过 MCP 协议访问这些资源。
- 使用 '/memory' 命令 (有限支持): 在 Cursor AI 的聊天输入框中,可以使用 '/memory status' 等命令查看 AI Memory 的状态。更高级的功能应通过 MCP 协议调用服务器提供的资源、工具和 Prompt 实现。
- 查看 Webview 界面: 运行 'AI Memory: Open Webview' 命令打开 Webview 界面,查看 AI Memory 的运行状态和进行相关操作。
- 停止 MCP 服务器: 如果需要停止 MCP 服务器,可以运行 'AI Memory: Stop MCP Server' 命令。
通过 AI Memory 扩展,您可以为您的 LLM 应用构建强大的项目上下文管理能力,提升 AI 辅助开发的效率和质量。