使用说明

项目简介

MCP Memory Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为 AI 模型提供持久化的记忆能力。它使用 Elasticsearch 作为知识图谱的存储,允许 AI 应用在不同会话间保持上下文连贯性,记住重要的信息,从而实现更有效、更个性化的 AI 对话体验。

主要功能点

  • 持久化记忆: 跨会话存储和检索信息,让 AI 记住用户在过去对话中提到的重要内容。
  • 智能搜索: 利用 Elasticsearch 的强大搜索能力,快速找到所需信息。
  • 上下文召回: AI 可以根据当前对话内容,自动检索并优先使用相关的记忆信息。
  • 关系理解: 支持实体之间的关系连接,模拟人类的联想记忆。
  • 长期/短期记忆: 区分临时细节和重要知识,更好地管理记忆内容。(代码中未明确区分,描述来自README)
  • 记忆区域 (Zones): 将信息组织到不同的领域(项目、客户、主题),方便管理和检索。
  • 工具集成: 通过 MCP 协议提供工具接口,例如知识图谱的创建、查询、更新和删除等操作,允许 LLM 客户端调用这些工具来管理记忆。

安装步骤

  1. 环境准备:
    • 确保已安装 Docker (用于运行 Elasticsearch) 和 Node.js (版本 18 或更高) 及 npm
  2. 克隆仓库:
    git clone https://github.com/j3k0/mcp-brain-tools.git
    cd mcp-brain-tools
  3. 安装依赖:
    npm install
  4. 启动 Elasticsearch:
    npm run es:start
    或者,您可以使用自己安装的 Elasticsearch 实例,并设置 'ES_NODE' 环境变量指向您的 Elasticsearch 地址。
  5. 构建项目:
    npm run build

服务器配置

MCP 服务器是一个独立的后台程序,需要配置启动命令才能被 MCP 客户端(如 Claude Desktop)调用。以下是 Claude Desktop 客户端的 MCP 服务器配置示例:

{
  "serverName": "MCP Memory",
  "command": "/path/to/mcp-brain-tools/launch.sh",  // 修改为 launch.sh 脚本的实际路径
  "args": [],
  "runInBackground": true,
  "showInMenu": true
}

参数说明:

  • 'serverName': MCP 服务器的名称,客户端显示用,可以自定义。
  • 'command': launch.sh 脚本的绝对路径。请根据您的实际文件路径进行修改。
  • 'args': 启动参数,本例中无需参数,保持为空数组即可。
  • 'runInBackground': 设置为 'true' 表示在后台运行 MCP 服务器。
  • 'showInMenu': 设置为 'true' 表示在客户端菜单中显示该 MCP 服务器选项。

launch.sh 脚本配置 (示例)

'launch.sh' 脚本负责启动 MCP Memory Server,您需要根据实际情况配置 Groq API 密钥(用于智能记忆检索功能,非必须)。

  1. 复制示例脚本:
    cp launch.example launch.sh
  2. 编辑 'launch.sh':
    nano launch.sh  # 或使用您喜欢的编辑器
    在 'launch.sh' 中,您可以设置 'GROQ_API_KEY' 环境变量为您自己的 Groq API 密钥。如果不需要智能记忆检索功能,可以留空。
  3. 添加执行权限:
    chmod +x launch.sh

基本使用方法

  1. 按照上述 服务器配置 说明,将 MCP Memory Server 添加到您的 MCP 客户端中(以 Claude Desktop 为例)。
  2. 启动 MCP Memory Server。
  3. 在 MCP 客户端中与 AI 进行对话。MCP Memory Server 将在后台自动记录和检索对话上下文,无需用户显式操作。
  4. 您可以使用提供的 Admin CLI 工具 ('node dist/admin-cli.js') 来管理知识图谱,例如搜索、查看实体信息、备份等。具体命令请参考仓库 README 文档。

注意:

  • 首次使用前请确保 Elasticsearch 服务已成功启动。
  • 配置文件路径和 API 密钥等敏感信息请妥善保管。
  • 详细使用方法和高级功能请参考仓库 README 文档和在线文档。

信息

分类

数据库与文件