使用说明

项目简介

Smart Memory MCP v2 Server 是一个基于 Model Context Protocol (MCP) 的后端实现,旨在为智能应用提供强大的上下文管理能力。它通过资源管理、工具注册和 Prompt 模板等核心功能,使得 LLM 客户端能够以标准化方式获取和利用上下文信息,从而构建更加智能和用户友好的应用。此仓库是该服务器的实现,特别针对 VS Code 集成进行了优化。

主要功能点

  • 资源 (Resources) 管理: 通过 Memory Bank 实现结构化记忆存储和检索,支持多种分类和配置,有效管理 LLM 应用所需的上下文信息。
  • 工具 (Tools) 注册与执行: 虽然仓库信息中未直接提及 Tools 功能,但 MCP 的定义包含此项,服务器具备未来扩展工具注册和执行能力的基础。
  • Prompt 模板 (Prompts) 定义与渲染: 同样,虽然仓库信息中未明确提及 Prompt 模板,但 MCP 的定义包含此项,服务器设计上可能支持 Prompt 模板的集成,以支持定制化的 LLM 交互模式。
  • 上下文感知内存优化: 具备上下文感知的内存优化功能,能够根据配置自动管理和优化记忆存储,提升效率和资源利用率。
  • VS Code 扩展集成: 专门为 VS Code 扩展集成设计,提供与 VS Code 环境无缝对接的能力。
  • 自动备份与崩溃恢复: 具备自动备份和崩溃恢复机制,保障数据安全性和服务稳定性。
  • 父进程监控: 能够监控父进程(如 VS Code)的状态,并在父进程关闭时自动安全关闭服务器。

安装步骤

  1. 环境准备:
    • 确保已安装 Rust (最新稳定版) 和 Node.js (v18 或更高版本) 以及 VS Code
  2. 克隆仓库:
    git clone https://github.com/shipdocs/smart-memory-mcp-v2.git
    cd smart-memory-mcp-v2
  3. 构建核心服务器:
    cd core
    cargo build --release
    cd ..
  4. 安装 VS Code 扩展:
    • 虽然此仓库主要提供服务器端实现,但根据描述,可能存在配套的 VS Code 扩展(未在此仓库中直接提供)。如果需要 VS Code 集成,请查找并安装 "Smart Memory MCP" VS Code 扩展(可能在 VS Code Marketplace 上发布)。

服务器配置 (MCP 客户端配置示例)

MCP 客户端(例如 VS Code 扩展或其他 LLM 应用)需要配置连接到此 MCP 服务器。以下是一个 MCP 客户端配置示例(JSON 格式),用于说明如何配置客户端以连接到 Smart Memory MCP v2 Server。

{
  "serverName": "smart-memory-mcp-server",  // 服务器名称,客户端用于标识和管理多个MCP服务器连接
  "command": "node",                       // 启动服务器的命令,这里假设使用 node 运行,实际应根据 core/target/release/smart-memory-mcp-core 的运行方式配置
  "args": [                                // 启动服务器的参数
    "path/to/smart-memory-mcp-v2/core/target/release/smart-memory-mcp-core" //  指向编译后的服务器核心文件路径,根据实际路径修改
  ],
  "env": {                                 // 环境变量配置,与服务器启动所需环境变量保持一致
    "RUST_LOG": "info",                    //  设置 Rust 日志级别为 info
    "DB_PATH": "~/.smart-memory/memories.db", //  数据库文件路径,可自定义
    "CONFIG_PATH": "~/.smart-memory/config.json" // 配置文件路径,可自定义
  },
  "disabled": false,                       //  是否禁用此服务器配置,false 表示启用
  "timeout": 60,                           //  连接超时时间,单位为秒
  "alwaysAllowMethods": [                  //  允许客户端始终调用的方法列表,用于权限控制
    "handleUmbCommand",                   //  处理 UMB 命令,用于上下文更新
    "updateMemoryBank",                   //  更新记忆库
    "storeMemory",                        //  存储记忆
    "retrieveMemory",                     //  检索记忆
    "optimizeMemory",                     //  优化记忆
    "getContext"                          //  获取上下文
  ]
}

请注意:

  • 'command' 和 'args' 需要根据 'core/target/release/smart-memory-mcp-core' 的实际运行方式进行配置。例如,如果直接运行编译后的二进制文件,'command' 可以设置为二进制文件的绝对路径,'args' 为空数组。
  • 'env' 中的环境变量需要与服务器启动时所需的环境变量一致,例如数据库路径、配置文件路径等。
  • 上述配置为示例,MCP客户端的具体配置方式和参数可能会有所不同,请参考 MCP 客户端的文档进行配置。

基本使用方法

  1. 启动服务器: 服务器核心代码位于 'core' 目录下,编译后可运行。通常,服务器会在后台运行,监听来自 MCP 客户端的请求。
  2. 配置 MCP 客户端: 在 MCP 客户端(如 VS Code 扩展)中,配置上述服务器连接信息。
  3. 使用 MCP 客户端: 通过 MCP 客户端提供的界面或 API,即可与 Smart Memory MCP 服务器进行交互,实现记忆存储、上下文检索等功能。例如,在 VS Code 中,可以使用扩展提供的命令或界面来存储代码片段、检索上下文信息,并利用服务器提供的智能记忆功能。

信息

分类

开发者工具