使用说明

项目简介

1scan MCP Server 是 1scan 项目的一部分,旨在为 AI 助手提供区块链数据的便捷访问能力。它作为一个 MCP 服务器,允许 AI 模型(如 Cursor IDE 中的 Claude)通过标准化的 Model Context Protocol 协议,直接查询和利用来自多个区块链浏览器 API 的数据。

主要功能点

  • 统一API接入: 聚合了多个区块链浏览器的 API,提供统一的访问入口,简化了多链数据查询的复杂性。
  • MCP协议支持: 实现了 Model Context Protocol 协议,可以无缝集成到支持 MCP 协议的 AI 客户端,如 Cursor IDE。
  • 丰富的区块链数据工具: 内置多种工具,涵盖了区块链数据查询的常用功能,例如:
    • 查询账户余额 (Account Balance)
    • 查询代币余额 (Token Balance)
    • 获取交易详情 (Transaction Details)
    • 获取区块信息 (Block Information)
    • 查询合约 ABI (Contract ABI)
    • 查询合约源代码 (Contract Source Code)
    • 获取 Gas 价格 (Gas Price)
    • ... 等等

安装步骤

  1. 安装 Go 环境:确保你的机器上已安装 Go 语言环境 (>= 1.20)。
  2. 安装 1scan:
    • 方法一:使用 'go install' 命令
      go install github.com/huahuayu/1scan@latest
    • 方法二:从源代码构建
      git clone https://github.com/huahuayu/1scan.git
      cd 1scan
      make build
  3. 配置 API 密钥: 复制 'config.json' 文件到服务器可访问的路径,并根据你的需求修改配置文件,填入各个区块链浏览器 API 的密钥。你需要自行前往各个区块链浏览器平台申请 API 密钥。示例 'config.json' 内容如下:
    {
      "1": {
        "endpoint": "api.etherscan.io",
        "keys": {
          "YOUR_ETHERSCAN_API_KEY_1": 5,
          "YOUR_ETHERSCAN_API_KEY_2": 10
        }
      },
      "56": {
        "endpoint": "api.bscscan.com",
        "keys": {
          "YOUR_BSCSCAN_API_KEY": 5
        }
      }
    }
    • 'chainID': 区块链网络 ID (例如,'1' 代表 Ethereum)。
    • 'endpoint': 区块链浏览器 API 的 endpoint 地址。
    • 'keys': API 密钥及其速率限制 (requests per second)。

服务器配置 (MCP 客户端配置)

对于 MCP 客户端(例如 Cursor IDE),你需要配置 MCP 服务器的连接信息。以下是一个典型的 MCP 服务器配置示例,用于连接到 1scan MCP Server:

{
  "server name": "1scan",
  "command": "1scanmcp",
  "args": [
    "-config",
    "/path/to/config.json",  // 替换为你的 config.json 文件路径
    "-port",
    "3000",                 // MCP 服务器端口,默认为 3000
    "-path",
    "/mcp",                  // MCP 服务器路径,默认为 /mcp
    "-transport",
    "sse"                    // 传输协议,默认为 sse (Server-Sent Events)
  ]
}

参数注释:

  • 'server name': MCP 服务器的名称,可以自定义。
  • 'command': 启动 MCP 服务器的可执行文件命令,这里是 '1scanmcp' (假设 '1scanmcp' 可执行文件在 PATH 环境变量中,或者使用绝对路径)。
  • 'args': 传递给 '1scanmcp' 命令的参数列表。
    • '-config': 指定 'config.json' 配置文件路径。请将 '/path/to/config.json' 替换为你实际的 'config.json' 文件路径。
    • '-port': 指定 MCP 服务器监听的端口号,默认为 '3000'。
    • '-path': 指定 MCP 服务器的路径,默认为 '/mcp'。客户端通常通过 'http://服务器地址:端口/路径/sse' 进行 SSE 连接。
    • '-transport': 指定传输协议,默认为 'sse'。也可以选择 'stdio' (标准输入输出)。

注意: 请根据你的实际部署环境和 'config.json' 文件路径,调整上述 'args' 参数。MCP 客户端需要根据此配置启动 '1scanmcp' 服务器进程并与之通信。

基本使用方法

  1. 启动 1scan API Server (可选): 如果你不仅需要 MCP 服务,还需要作为 API 网关使用,可以先启动 1scan API Server:
    1scan -config /path/to/config.json
  2. 启动 1scan MCP Server:
    1scanmcp -config /path/to/config.json -port 3000 -path /mcp -transport sse
    或使用 'make' 命令:
    make run-1scanmcp
  3. 配置 MCP 客户端: 在你的 MCP 客户端(如 Cursor IDE)中,添加新的 MCP 服务器,并填入上述 服务器配置 (MCP 客户端配置) 中的 JSON 配置信息,并确保 URL 设置为 'http://localhost:3000/mcp/sse' (如果使用默认配置)。
  4. 在 AI 对话中使用: 现在你可以在 AI 对话中直接使用区块链数据查询工具了。例如在 Cursor IDE 中提问:
    Can you check the balance of address 0x742d35Cc6634C0532925a3b844Bc454e4438f44e on Ethereum?
    AI 助手将调用 1scan MCP Server 提供的工具来获取区块链数据并返回结果。

信息

分类

网页与API