使用说明

项目简介

本项目 'mcp-server-memory-file' 是一个基于 Model Context Protocol (MCP) 的服务器实现,它使用纯文本文件来存储聊天记忆。该服务器旨在为大型语言模型(LLMs)如 Claude 提供一种简单有效的方式来管理对话上下文记忆,从而提升LLM在多轮对话中的表现。通过此服务器,LLM可以记录、检索和删除记忆,实现更连贯和个性化的对话体验。

主要功能点

  • 文本文件记忆存储: 使用纯文本文件 ('memories.txt') 存储记忆,每行代表一条记忆。
  • 记忆管理工具: 提供以下工具供LLM客户端调用,管理记忆:
    • 'append_memories': 添加新的记忆条目。
    • 'search_memory': 搜索包含特定关键词的记忆条目。
    • 'delete_memory': 删除包含特定关键词的记忆条目。
    • 'list_memory': 列出所有记忆条目。
  • MCP协议兼容: 完全兼容 Model Context Protocol,可以通过标准的MCP客户端进行连接和操作。
  • 易于部署和配置: 基于 Node.js 开发,易于安装和运行,配置简单。

安装步骤

  1. 环境准备: 确保已安装 Node.js 和 npm (或 yarn)。
  2. 下载仓库: 使用 Git 克隆仓库到本地:
    git clone https://github.com/g0t4/mcp-server-memory-file.git
  3. 进入目录: 导航到项目目录:
    cd mcp-server-memory-file
  4. 安装依赖: 安装项目所需的 npm 依赖:
    npm install
  5. 构建项目: 编译 TypeScript 代码到 JavaScript:
    npm run build

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude 桌面应用)配合使用,您需要在客户端中配置服务器连接信息。以下是一个典型的 JSON 格式配置示例,您需要将其添加到 MCP 客户端的服务器配置中。

{
  "serverName": "memory-file-server",  // 服务器名称,可以自定义
  "command": "node",                 // 启动服务器的命令,这里使用 node 运行 JavaScript
  "args": ["dist/index.js"]         // 启动命令的参数,指向编译后的服务器入口文件
}

配置参数说明:

  • 'serverName': 为您的服务器指定一个易于识别的名称。
  • 'command': 指定用于启动服务器进程的可执行命令。对于 Node.js 服务器,通常设置为 'node'。
  • 'args': 一个字符串数组,包含传递给 'command' 的参数。这里 'dist/index.js' 指向编译后的服务器入口文件。

基本使用方法

  1. 启动服务器: 在项目根目录下,运行以下命令启动 MCP 服务器:

    npm start

    这将执行 'node dist/index.js' 命令,启动基于文本文件的记忆服务器。

  2. 配置 MCP 客户端: 在您的 MCP 客户端 (如 Claude 桌面应用) 中,根据上述 “服务器配置” 部分的说明,添加并配置 'memory-file-server'。确保客户端能够正确连接到服务器。

  3. 使用记忆工具: 一旦客户端成功连接到服务器,LLM 就可以通过调用预定义的工具来管理记忆。例如,LLM 可以使用 'append_memories' 工具添加新的记忆,使用 'search_memory' 工具搜索相关记忆,等等。具体的工具调用方式取决于 MCP 客户端和 LLM 的实现。

注意: 确保 'memories.txt' 文件存在于 'dist' 目录下或服务器能够访问的路径。首次启动服务器时,如果该文件不存在,服务器会自动创建。

信息

分类

数据库与文件