使用说明

项目简介

Knowledge Graph Memory Server 是一个基于知识图谱的 MCP 服务器,旨在为大型语言模型 (LLM) 提供持久化的记忆能力。它通过在本地知识图谱中存储实体、关系和观察,使 LLM 能够跨会话记住用户的信息、偏好和交互历史。此服务器实现了 Model Context Protocol (MCP),可以与兼容 MCP 协议的客户端(如 Cursor, Cline, Claude Desktop 等)配合使用。

主要功能点

  • 知识图谱存储: 使用 JSONL 文件在本地持久化存储知识图谱数据。
  • 实体、关系和观察: 支持知识图谱的基本元素,包括实体 (Entities)、关系 (Relations) 和观察 (Observations),用于结构化地存储信息。
  • 丰富的 API 工具: 提供了一系列工具 (Tools),用于对知识图谱进行增删改查操作,包括:
    • 实体管理: 创建、删除实体。
    • 关系管理: 创建、删除实体之间的关系。
    • 观察管理: 为实体添加、删除观察信息。
    • 数据检索: 读取整个知识图谱、根据关键词搜索节点、根据名称打开特定节点。
  • 可配置的记忆路径: 允许用户自定义知识图谱数据文件的存储路径。

安装步骤

Knowledge Graph Memory Server 通常无需手动安装,可以通过以下两种方式集成到 MCP 客户端中:

  1. 通过 Smithery 安装 (Claude Desktop): 如果您使用 Claude Desktop,可以使用 Smithery 命令行工具自动安装:

    npx -y @smithery/cli install @itseasy21/mcp-knowledge-graph --client claude
  2. 手动配置 (Cursor, Cline, Claude Desktop): 手动编辑 MCP 客户端的配置文件 ('mcp.json' 或 'claude_desktop_config.json'),添加服务器配置信息。

服务器配置

在 MCP 客户端的配置文件中,您需要添加 'mcpServers' 配置项,指定 Knowledge Graph Memory Server 的启动方式。以下是一个典型的配置示例:

{
    "mcpServers": {
      "memory": {  // 服务器名称,可以自定义
        "command": "npx", // 启动命令,通常为 npx
        "args": [  // 启动参数
          "-y",
          "@itseasy21/mcp-knowledge-graph" //  服务器 npm 包名
        ],
        "env": {
          "MEMORY_FILE_PATH": "/path/to/your/memory.jsonl" // 可选:自定义记忆文件路径,默认为服务器安装目录下的 memory.jsonl。将 "/path/to/your/memory.jsonl" 替换为您希望存储记忆文件的实际路径
        }
      }
    }
  }

配置参数说明:

  • 'server name': 'memory' (可以自定义,用于在客户端中引用该服务器)
  • 'command': 'npx' (Node Package Execute,用于执行 npm 包)
  • 'args':
    • '-y': (可选) 'npx' 参数,表示自动确认安装包。
    • '@itseasy21/mcp-knowledge-graph': Knowledge Graph Memory Server 的 npm 包名。
  • 'env': (可选) 环境变量配置
    • 'MEMORY_FILE_PATH': (可选) 用于自定义知识图谱数据文件 ('memory.jsonl') 的存储路径。如果不配置,则默认存储在服务器安装目录下。

注意: 请根据您的实际需求修改 'MEMORY_FILE_PATH' 环境变量的值,指定合适的记忆文件存储路径。

基本使用方法

配置完成后,MCP 客户端将自动连接到 Knowledge Graph Memory Server。您可以通过在 Prompt 中指示 LLM 使用 'create_entities', 'create_relations', 'add_observations', 'search_nodes' 等工具来操作知识图谱,从而实现记忆的存储和检索。

例如,在 Claude 的 Custom Instructions 中,您可以使用类似以下的 Prompt 指示模型使用记忆功能:

Always begin your chat by saying only "Remembering..." and retrieve all relevant information from your knowledge graph using the 'read_graph' tool.
If you learn new information about the user, use tools like 'create_entities', 'create_relations', and 'add_observations' to update your memory.

更详细的工具使用方法和 Prompt 示例,请参考仓库的 'README.md' 文件。

信息

分类

数据库与文件