使用说明

项目简介

Web3 MCP Server 是一个基于 Model Context Protocol (MCP) 标准构建的服务器实现，它利用 Ankr Advanced API 作为数据源，为大型语言模型（LLM）客户端提供便捷的区块链数据访问服务。该服务器旨在简化 LLM 应用与 Web3 世界的集成，使得开发者可以轻松地构建能够理解和利用区块链信息的智能应用。

主要功能点

全面的 Ankr Advanced API 封装: 完整地封装了 Ankr Advanced API 的所有端点，包括 NFT API、Query API 和 Token API。
NFT 数据访问: 提供 NFT 元数据、持有者信息、交易记录以及所有权查询等功能。
区块链查询: 支持区块链统计信息、区块数据、交易日志和交易详情的检索。
Token 数据访问: 允许查询 Token 余额、价格、持有者信息和交易历史。
多链支持: 支持包括以太坊、BSC、Polygon、Avalanche 等在内的多个主流区块链网络。

安装步骤

克隆仓库

git clone https://github.com/tumf/web3-mcp.git
cd web3-mcp

安装依赖 建议使用 'uv' 包管理器安装，以获得更快的安装速度。
```
uv pip install -e .
```

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 Web3 MCP Server。您无需修改以下 JSON 代码，只需复制粘贴到您的 MCP 客户端配置中即可。

{
  "mcpServers": {
    "web3": {
      "command": "uvx",
      "args": [
        "web3-mcp"
      ],
      "env": {
        "ANKR_ENDPOINT": "YOUR_ANKR_RPC_ENDPOINT",
        "ANKR_PRIVATE_KEY": "YOUR_PRIVATE_KEY"
      }
    }
  }
}

配置参数说明:

'server name': 服务器名称，这里设置为 "web3"。
'command': 启动服务器的命令，这里使用 'uvx' 运行 'web3-mcp'。
'args': 传递给命令的参数，这里为空。
'env': 环境变量配置，包含：
- 'ANKR_ENDPOINT': (必填) 您的 Ankr RPC endpoint 地址。您需要在 Ankr 官网获取。
- 'ANKR_PRIVATE_KEY': (可选，但推荐) 您的 Ankr 私钥。用于进行需要身份验证的 API 请求。如果不需要可以不填。

请务必将 'YOUR_ANKR_RPC_ENDPOINT' 替换为您实际的 Ankr RPC endpoint，'YOUR_PRIVATE_KEY' 替换为您的 Ankr 私钥（如果需要）。

基本使用方法

配置环境变量 在运行服务器之前，您需要设置必要的环境变量。

export ANKR_ENDPOINT="YOUR_ANKR_RPC_ENDPOINT"
export ANKR_PRIVATE_KEY="YOUR_PRIVATE_KEY"  # 可选

同样，请替换为您的实际 endpoint 和私钥。

运行服务器 您可以使用以下命令启动 Web3 MCP Server：

python -m web3_mcp

或者，您也可以在 Python 代码中初始化并运行服务器：

from web3_mcp.server import init_server

# 初始化 MCP 服务器
mcp = init_server(
    name="Ankr MCP Example",
    endpoint="YOUR_ANKR_RPC_ENDPOINT",
    private_key="YOUR_PRIVATE_KEY" # 可选
)

# 运行服务器
mcp.run()

服务器成功启动后，MCP 客户端即可通过配置的连接信息与其进行通信，并调用提供的工具来获取区块链数据。

关键词