使用说明

项目简介

Bankless Onchain MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为 AI 模型提供访问区块链数据的能力。它通过 Bankless API 提供了一系列工具,用于查询链上合约状态、事件、交易记录以及代币信息。

主要功能点

  • 合约操作: 支持读取智能合约状态 ('read_contract')、获取代理合约地址 ('get_proxy')、获取合约 ABI ('get_abi') 和源代码 ('get_source')。
  • 事件操作: 支持查询合约事件日志 ('get_events')、构建事件主题 ('build_event_topic')。
  • 交易操作: 支持获取用户交易历史 ('get_transaction_history')、查询交易详细信息 ('get_transaction_info')。
  • 代币操作: 支持获取原生代币余额 ('get_native_balance')、查询网络上所有代币余额 ('get_token_balances_on_network')。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 执行以下命令安装 '@bankless/onchain-mcp' 包:
    npm install @bankless/onchain-mcp

服务器配置

MCP 客户端需要配置以下信息以连接 Bankless Onchain MCP Server:

{
  "mcpServers": {
    "bankless": {
      "command": "npx",
      "args": [
        "@bankless/onchain-mcp"
      ],
      "env": {
        "BANKLESS_API_TOKEN": "YOUR_BANKLESS_API_TOKEN" // 请替换为你的 Bankless API Token,获取方式请参考 https://docs.bankless.com/bankless-api/other-services/onchain-mcp
      }
    }
  }
}

配置参数说明:

  • 'server name': 服务器名称,这里设置为 "bankless"。
  • 'command': 启动服务器的命令,使用 'npx' 执行 '@bankless/onchain-mcp' 包。
  • 'args': 启动命令的参数,这里为空数组。
  • 'env': 环境变量配置,'BANKLESS_API_TOKEN' 用于 Bankless API 的身份验证,请务必替换为你的 Bankless API Token

基本使用方法

  1. 设置 Bankless API Token: 在运行服务器之前,请先设置 'BANKLESS_API_TOKEN' 环境变量。
    export BANKLESS_API_TOKEN=your_api_token_here
  2. 启动服务器: 在命令行中执行以下命令启动 Bankless Onchain MCP Server:
    npx @bankless/onchain-mcp
  3. 客户端调用: 使用兼容 MCP 协议的客户端,配置上述服务器连接信息后,即可调用服务器提供的各种区块链数据查询工具。具体的工具名称和参数可以参考仓库的 README.md 文档或服务器返回的 'ListToolsRequest' 响应。

信息

分类

网页与API