使用说明

项目简介

Memory Usage Dashboard 是一个使用 Electron 和 React 开发的桌面应用程序,它作为一个 MCP 服务器实现,专注于提供本地内存数据管理服务。该应用允许用户存储文本信息并附加标签,随后可以通过关键词或标签检索这些信息。它旨在作为一个独立的内存上下文服务,方便集成到其他支持 MCP 协议的 LLM 应用中。

主要功能点

  • 资源管理 (内存数据): 允许用户在本地存储和管理非结构化文本数据,作为 LLM 应用的长期或短期记忆。
  • 数据访问能力: 提供基于关键词的语义搜索功能,以及基于标签的检索和删除功能,方便 LLM 应用访问和操作内存数据。
  • 工具注册和执行: 实现了符合 MCP 协议的工具接口,例如 'store_memory'(存储记忆)、'retrieve_memory'(检索记忆)、'search_by_tag'(按标签搜索)、'check_database_health'(检查数据库健康状况)等,可以通过 JSON-RPC 协议被 MCP 客户端调用。
  • 健康监控和维护: 提供数据库健康检查、性能统计、数据库优化和备份功能,确保内存服务的稳定性和可靠性。
  • 用户友好的界面: 提供直观的图形界面,方便用户操作和监控内存服务状态。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/doobidoo/mcp-memory-dashboard.git
    cd mcp-memory-dashboard
  2. 安装依赖: 确保你已安装 Node.js 和 npm。运行以下命令安装项目依赖:

    npm install
  3. 启动应用: 在开发模式下启动应用,可以使用以下命令:

    npm run dev

    或者,构建并启动生产版本应用:

    npm run start

服务器配置

由于 Memory Usage Dashboard 是一个 Electron 桌面应用,它本身即为 MCP 服务器的宿主,无需额外的服务器启动步骤。对于 MCP 客户端,配置的关键在于指定如何通过 Electron 的 IPC (Inter-Process Communication) 机制与此 MCP 服务器进行通信。

以下是一个 MCP 客户端可能需要配置的关键信息 (JSON 格式,仅供参考,实际客户端配置方式可能不同,重点是理解服务器能力和工具名称):

{
  "serverName": "memory-dashboard",
  "transport": "electron-ipc",
  "capabilities": {
    "tools": [
      {
        "name": "store_memory",
        "description": "Store new information with optional tags"
      },
      {
        "name": "retrieve_memory",
        "description": "Perform semantic search for relevant memories"
      },
      {
        "name": "search_by_tag",
        "description": "Retrieve memories by specific tags"
      },
      {
        "name": "check_database_health",
        "description": "Retrieve database health metrics"
      },
      {
        "name": "get_stats",
        "description": "Retrieve memory service statistics"
      },
      {
        "name": "optimize_db",
        "description": "Optimize database performance"
      },
      {
        "name": "create_backup",
        "description": "Create a backup of the memory database"
      }
    ]
  }
}

基本使用方法

  1. 启动 Memory Usage Dashboard 应用。
  2. 选择功能标签页: 在界面顶部,你可以切换 "Store Memory" (存储记忆), "Search Memories" (搜索记忆), 和 "Tag Management" (标签管理) 等功能。
  3. 存储记忆: 在 "Store Memory" 标签页,输入文本内容,可选择性添加逗号分隔的标签,点击 "Store" 按钮保存记忆。
  4. 搜索记忆: 在 "Search Memories" 标签页,输入查询关键词,点击 "Search" 按钮检索相关记忆。检索结果将显示在下方,包括内容片段、相似度 (如有) 和标签。
  5. 标签管理: 在 "Tag Management" 标签页,输入要删除的标签,点击 "Delete Tag" 按钮删除所有包含该标签的记忆。
  6. 监控服务状态: 仪表盘底部显示内存服务的统计信息,如记忆总数、标签数量、数据库健康状况和平均查询时间。
  7. 数据库维护: 使用 "Optimize Database" 按钮优化数据库性能,使用 "Create Backup" 按钮创建数据备份。

注意: 由于这是一个桌面应用,MCP 客户端的集成可能需要自定义 Electron IPC 通信机制,或者通过其他桥接方式与此应用进行交互。

信息

分类

桌面与硬件