使用说明

项目简介

mcp-brain 是一个实现了 Model Context Protocol (MCP) 的服务器,它作为一个认知记忆系统,利用 Supabase 数据库来持久化存储知识图谱。该项目旨在为 Claude 等 LLM 提供跨不同会话和设备的记忆能力,使其能够记住并利用过去的交互信息和知识。

主要功能点

  • 持久化存储: 使用 Supabase 数据库存储知识图谱数据,确保数据在不同会话和设备之间持久存在。
  • 知识图谱结构: 以实体和关系的形式组织和存储信息,支持构建复杂的知识网络。
  • 并发安全: 通过数据库层面的锁机制,保证多客户端同时访问时的并发安全性。
  • 跨平台支持: 支持 macOS, Linux, Windows 等多种操作系统。
  • 自动初始化: 首次运行时自动创建数据库表结构。
  • 提供工具: 通过 MCP 协议提供 'read_graph', 'create_entities', 'create_relations' 三个工具,允许 LLM 客户端读取和修改知识图谱。

安装步骤

  1. 准备 Supabase:

    • 访问 https://supabase.com 创建一个新的 Supabase 项目,或者使用已有的 Supabase 项目。
    • 获取项目的 URLAPI 密钥 (在 Project Settings > API 中)。
  2. 克隆仓库并构建项目:

    git clone https://github.com/TouristShaun/mcp-brain.git
    cd mcp-brain
    npm install
    npm run build
  3. 配置 Supabase 凭据:

    • 运行配置脚本,按照提示输入 Supabase URL 和 API 密钥:
      npm run configure
    • 或者手动编辑 MCP 客户端的配置文件 ('cline_mcp_settings.json'),添加或更新 'mcp-brain' 服务器配置(具体文件路径见下方 服务器配置 部分)。
  4. 应用配置更改:

    • 如果 VSCode 已打开,关闭所有 Claude 对话,并运行 "Developer: Reload Window" 命令 (Cmd/Ctrl + Shift + P,输入 "reload")。
    • 如果 VSCode 未打开,直接启动 VSCode 即可。

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。对于 VSCode Claude 插件,配置文件通常位于:

  • macOS: '~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json'
  • Linux: '~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json'
  • Windows: '%APPDATA%/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json'

在配置文件中,'mcpServers' 字段下添加或更新 'mcp-brain' 的配置,示例如下:

{
  "mcpServers": {
    "mcp-brain": {
      "command": "node",
      "args": ["/path/to/mcp-brain/dist/index.js"],
      "env": {
        "SUPABASE_URL": "your-project-url",
        "SUPABASE_KEY": "your-api-key",
        "DEBUG": "false"
      }
    }
    // ... 其他 MCP 服务器配置 ...
  }
}

配置参数说明:

  • '"mcp-brain"': 服务器名称,在客户端中用于标识和选择该服务器。
  • '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行时。
  • '"args": ["/path/to/mcp-brain/dist/index.js"]': 命令参数,指向编译后的服务器入口文件 'dist/index.js' 的绝对路径。请将 '/path/to/mcp-brain' 替换为实际的项目代码路径。
  • '"env"': 环境变量配置。
    • '"SUPABASE_URL"': 您的 Supabase 项目 URL。
    • '"SUPABASE_KEY"': 您的 Supabase 项目 API 密钥。
    • '"DEBUG": "false"': 是否启用调试日志,默认为关闭。

基本使用方法

配置完成后,在 Claude 对话中,你可以指示 Claude 使用 brain 提供的工具来操作知识图谱。例如:

  • 询问 Claude 是否可以使用 brain:'Can you use your brain?'
  • 让 Claude 读取整个知识图谱:'@mcp-brain read_graph' (具体指令可能需要参考 Claude 插件或客户端的文档)
  • 让 Claude 存储新的记忆 (实体):'@mcp-brain create_entities entities=[{"name": "实体名称", "entity_type": "实体类型", "observations": ["观察信息1", "观察信息2"]}]'
  • 让 Claude 创建关系:'@mcp-brain create_relations relations=[{"from": "实体1名称", "to": "实体2名称", "relation_type": "关系类型"}]'

请根据实际的 MCP 客户端使用方式调用这些工具。

信息

分类

数据库与文件