Recall MCP Server 使用说明

项目简介

Recall MCP Server 是一个基于 Model Context Protocol (MCP) 实现的服务端应用,它充当 LLM 客户端(如 Cursor, Claude Desktop)与 Recall 区块链存储网络之间的桥梁。通过此 MCP Server,LLM 客户端可以安全地访问和操作 Recall 网络上的数据,例如账户信息、存储桶(buckets)和对象(objects)。该服务器特别注重私钥安全,采取多层保护措施防止私钥泄露。

主要功能点

  • 账户操作:
    • 获取 Recall 账户信息(地址、余额等)
    • 查询账户信用额度
    • 购买信用额度
  • 存储桶(Bucket)操作:
    • 列出所有存储桶
    • 创建新的存储桶
  • 对象(Object)操作:
    • 从存储桶中获取对象
    • 向存储桶中添加对象
    • 列出存储桶中的对象
  • 安全性:
    • 多层私钥保护机制,防止私钥泄露给 LLM 或日志
    • 安全响应工具,避免在不安全的情况下回答有关私钥的问题

安装步骤

  1. 克隆仓库
    git clone https://github.com/recallnet/recall-mcp.git
    cd recall-mcp
  2. 安装依赖
    npm install
  3. 构建项目
    npm run build

服务器配置

MCP 服务器需要配置在 MCP 客户端中,例如 Cursor 或 Claude Desktop。配置的关键是提供服务器的启动命令 (command) 及其参数 (args),以及必要的环境变量 (env)。

Cursor 配置示例 (Settings > MCP Servers > Add Server):

{
  "name": "Recall MCP",  // 服务器名称,可自定义
  "type": "command",   // 服务器类型,选择 "command"
  "command": "node",   // 启动命令,使用 Node.js 运行
  "args": [             // 命令参数,指向编译后的 index.js 文件
    "/path/to/recall-mcp/dist/index.js"  // 请替换为 recall-mcp 项目 dist 目录下 index.js 文件的实际路径
  ],
  "env": {              // 环境变量配置,推荐直接在客户端配置,更安全
    "RECALL_PRIVATE_KEY": "your-private-key-here", // 你的 Recall 私钥,请替换为实际私钥,注意安全!
    "RECALL_NETWORK": "testnet",                  // Recall 网络,默认为 testnet,可选 mainnet
    "DEBUG": "true"                             // 可选,开启调试日志
  }
}

Claude Desktop 配置示例 (claude_desktop_config.json):

请编辑 Claude Desktop 的配置文件 'claude_desktop_config.json' (路径见 README),在 'mcpServers' 中添加以下配置:

{
  "mcpServers": {
    "recall-mcp-server": {    // 服务器的唯一标识符,可自定义
      "name": "Recall MCP",    // 服务器名称,显示在 Claude Desktop 中
      "type": "command",
      "command": "node",
      "args": [
        "/path/to/recall-mcp/dist/index.js" // 请替换为 recall-mcp 项目 dist 目录下 index.js 文件的实际路径
      ],
      "env": {
        "RECALL_PRIVATE_KEY": "your-private-key-here", // 你的 Recall 私钥,请替换为实际私钥,注意安全!
        "RECALL_NETWORK": "testnet",                  // Recall 网络,默认为 testnet,可选 mainnet
        "DEBUG": "true"                             // 可选,开启调试日志
      }
    }
  }
}

注意:

  • '/path/to/recall-mcp/dist/index.js': 请务必替换为 'recall-mcp' 项目编译后 'dist/index.js' 文件的绝对路径
  • 'your-private-key-here': 请替换为你的 Recall 私钥强烈建议 通过 MCP 客户端的环境变量配置方式提供私钥,避免将私钥硬编码在配置文件中。
  • '.env 文件 (Method 2, Fallback)': 如果选择使用 '.env' 文件配置私钥(不推荐),请参考 README 中的 "Method 2: Using a .env file (Fallback)" 部分进行配置,并务必设置 '.env' 文件的权限为 'chmod 600 .env' 以增强安全性。

基本使用方法

成功配置并启动 Recall MCP Server 后,在 Cursor 或 Claude Desktop 中,你可以通过自然语言指令调用 MCP 工具来与 Recall 网络交互。

例如,在 Cursor 中,你可以:

  1. 在聊天框中输入 '/tool_code' 或 '## tools' 触发工具调用。
  2. 在工具列表中选择 'recall-mcp' 服务器提供的工具,例如 'list_buckets' (列出存储桶), 'create_bucket' (创建存储桶), 'add_object' (添加对象) 等。
  3. 根据工具的参数提示,填写必要的参数(例如 bucket 地址、object key、data 等)。
  4. 执行工具,即可与 Recall 网络进行交互,并将结果返回到 LLM 客户端。

具体工具的使用方法和参数说明,请参考仓库 'README.md' 中的 "MCP Tools" 表格以及 'docs/usage.md' 文档。

安全性提示:

  • 私钥安全至关重要! 永远不要以任何方式泄露你的私钥。
  • 仔细阅读 README 中的 "Security ⚠️" 部分,了解服务器提供的安全保护措施和最佳实践。
  • 当 LLM 提示你输入或展示私钥时,务必拒绝。MCP 服务器已经安全地管理了私钥,无需手动暴露。

信息

分类

数据库与文件