使用说明

项目简介

3xpl-MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器,它基于 3xpl.com 提供的 JSON API 服务,为大型语言模型 (LLM) 应用提供区块链数据的访问能力。该服务器通过注册一系列工具,使得 LLM 能够查询和分析 48 个不同区块链网络上的数据,例如解析 ENS 域名、检测地址所属区块链、获取最新区块信息、查询交易和地址概览等。

主要功能点

  • 区块链数据访问: 提供对 48 个区块链网络数据的访问能力。
  • 丰富的数据查询工具: 内置多种工具,包括:
    • ENS 域名解析: 将 ENS 域名解析为区块链地址。
    • 区块链检测: 识别地址或交易所在的区块链网络。
    • 区块信息查询: 获取指定区块链的最新区块高度和区块详细信息。
    • 交易信息查询: 查询交易的概览信息,包括所属区块、确认数、包含的事件等。
    • 地址信息查询: 查询地址的概览信息,包括余额、待处理交易、最近交易等。
    • 链上事件统计: 获取指定区块链在过去 24 小时或内存池中的事件(交易、输入/输出等)数量。
    • 交易费用查询: 查询指定区块链过去 24 小时的平均交易费用。

安装步骤

  1. 克隆仓库
    git clone https://github.com/exekerey/3xpl-mcp.git
    cd 3xpl-mcp
  2. 创建并激活虚拟环境
    uv venv
    source .venv/bin/activate
  3. 安装依赖
    uv pip install -e .

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接到 3xpl-MCP 服务器。

{
  "3xpl_API": {
    "command": "uv",
    "args": [
      "run",
      "--with",
      "mcp[cli]",
      "mcp",
      "run",
      "/{:path_to_cloned}/3xpl_mcp/main.py"
    ]
  }
}

配置参数说明:

  • server name (服务器名称): '"3xpl_API"' - 服务器的名称,客户端用以识别和调用。
  • command (命令): '"uv"' - 用于启动服务器的命令,这里使用 'uv' (一个更快的 pip 和 venv 替代品,如果未安装,可能需要替换为 'python' 或 'python3')。
  • args (参数): 启动命令的参数列表,用于指定如何运行 MCP 服务器。
    • '"run"': 'uv run' 命令的子命令,表示运行 Python 脚本。
    • '"--with"': 'uv run' 的选项,用于指定要加载的插件或扩展。
    • '"mcp[cli]"': 指定加载 'mcp' 插件,并启用 'cli' (命令行界面) 功能,这通常是 MCP 服务器运行所必需的。
    • '"mcp"': 再次指定 'mcp',可能是插件内部的子命令或入口点。
    • '"run"': 再次指定 'run',可能是在 'mcp' 插件内部的运行命令。
    • '"/{:path_to_cloned}/3xpl_mcp/main.py"': 指定服务器主程序 'main.py' 的完整路径。 请务必将 '/{:path_to_cloned}' 替换为实际克隆仓库的本地路径。

注意:

  • 如果 MCP 服务器无法启动,您可能需要提供 'uv' 命令的完整路径。
  • 确保已安装 'uv',如果使用 'python' 命令,则需要将 'command' 更改为 '"python"' 或 '"python3"',并相应调整 'args' 参数。

基本使用方法

该 MCP 服务器设计用于与 LLM 客户端配合使用。客户端需要根据 MCP 协议与服务器建立连接,并可以通过 JSON-RPC 协议调用服务器提供的工具来获取区块链数据。

例如,LLM 客户端可以调用 'resolve_ens_domain' 工具来解析 ENS 域名,或调用 'get_address_overview' 工具来获取地址的概览信息。具体的工具调用方式和参数需要参考 MCP 协议和客户端的实现。

开发者可以参考仓库中的代码,特别是 'src/tools' 目录下的工具实现,来了解如何使用 3xpl JSON API 以及如何扩展或自定义工具。

信息

分类

网页与API