使用说明(Markdown 格式)简要介绍与操作要点,便于开发者快速理解与应用。

  • 项目简介

    • Nocturne Memory MCP 服务端是一个完整的 MCP 实现,搭载图数据库 Neo4j,支持以标准化的方式向 AI 客户端提供上下文信息和功能。核心能力包括:资源(实体、状态、子节点)读写、关系与章节管理、核心记忆的自动加载、以及基于快照的 Review/Rollback 机制,以确保 AI 修改的可控性和可追溯性。
    • MCP 功能要点包括:读取资源(read_resource)、修改资源(patch_resource)、创建内存章节(create_memory_chapter)、以及针对内存检索的工具性函数(search_memory)。还提供 memory://core 与 memory://index 这两个核心 MCP 资源,方便对话中快速读取与浏览记忆。
  • 主要功能点

    • MCP 核心接口
      • 读取资源:支持读取实体、直接边、章节等内存资源的内容与元信息,自动渲染为可编辑的文档区块。
      • 修改资源:对 Direct Edge、Relay Edge、Entity 等进行修改,变更会沿用版本化与快照机制留痕。
      • 创建章节:在关系下创建新的记忆章节(chapter),并将其与父边关联。
      • 搜索记忆:按关键字在记忆库中搜索,返回资源列表与简要摘要。
    • 数据库与持久化
      • 使用 Neo4j 作为后端图数据库,提供实体、状态、边等数据结构。
      • 提供快照与回滚机制,支持基于会话的快照管理,便于人类审核与回滚。
    • 人类界面与开发者工具对接
      • 提供 CORE MEMORY(memory://core)与 MEMORY INDEX(memory://index)资源,方便会话开始时快速初始化与导航。
    • 安全性与管理
      • 支持快照创建前的自动快照、回滚时的状态迁移、以及对直接边、章节的严格版本控制。
      • 内置维护工具与导出/导入能力,便于孤儿节点清理、内存结构管理等。
  • 安装与运行步骤

    • 依赖与环境
      • Python 3.10 及以上
      • Neo4j 数据库(本地或云端 AuraDB 均可)
      • Node 及前端可选,用于可视化前端
    • 启动后端
      • 在仓库根目录下安装依赖并启动 FastAPI/ASGI 服务(具体依据项目中的 backend/mcp_server.py 路径执行即可,该脚本会启动 MCP 服务器并暴露 MCP 功能)。
    • 配置 MCP 客户端
      • MCP 客户端需要一个 JSON 配置来指明服务器信息与启动命令。下面给出配置示例信息字段说明,实际路径需按你的环境替换:
        • server name: nocturne-memory
        • command: python
        • args: ["/path/to/nocturne_memory/backend/mcp_server.py"]
      • 示例配置(请替换为实际绝对路径): { "server": "nocturne-memory", "command": "python", "args": ["/absolute/path/to/nocturne_memory/backend/mcp_server.py"] }
      • 重要说明:如果你使用 Antigravity 或其他环境,请按照仓库内的说明使用 mcp_wrapper.py 作为入口参数,例如在 Antigravity 环境中将 args 指向 mcp_wrapper.py,以解决特定环境问题。
  • 基本使用方法

    • 启动与连接
      • 启动后端 MCP 服务器,确保 Neo4j 数据库可访问。
      • 使用支持 MCP 的 AI 客户端(如 Claude Desktop、Antigravity 等),在对话窗口中配置 MCP 服务器信息,确保能通过 read_resource、patch_resource、create_memory_chapter、search_memory 等工具与知识库交互。
    • 常用工作流
      • AI 读取将要使用的记忆资源,例如 memory://core、char_nocturne、rel:char_nocturne>char_user 等,获取上下文与知识。
      • 通过 patch_resource 修改边/章节/实体的内容,并自动产生新版本与快照。
      • 如需新增章节,使用 create_memory_chapter,传入资源ID(如 rel:viewer>target)、章节标题与内容。
      • 使用 memory://index 全局目录快速定位记忆。
      • 使用 review 的快照与 diff 功能进行变更对比、回滚与审计。
    • 重要提示
      • Core Memories 可以通过 CORE_MEMORY_IDS 在代码中静默配置,启动时自动加载,帮助 AI 启动时快速获得核心记忆。
      • 删除与回滚具有潜在风险,请在 Review 页面或有经验人员监督下执行。
  • 运行与部署注意事项

    • 确保 Neo4j 数据库可达,环境变量 NE04J_URI、dbuser、dbpassword 等正确配置(后端代码会尝试自动初始化与加载种子数据)。
    • MCP 服务器对接客户端时,请遵循客户端提供的配置方式进行集成,路径与命令需严格匹配实际环境。
  • 进一步探索

    • 熟悉后端 REST/Graph 相关路由、以及 MCP 服务器对接后的消息交互细节,以便实现自定义的 Tools、Prompts、Templates 等扩展。

信息

分类

AI与计算