ZAN MCP Server 使用说明

项目简介

ZAN MCP Server 是一个实现了 Model Context Protocol 规范的服务器，专为 ZAN.top 区块链节点服务设计。它为 AI 助手提供了一系列工具和接口，使其能够通过 MCP 协议无缝访问和处理区块链数据。

主要功能点

多链支持: 支持包括 Ethereum, Polygon, BSC, Arbitrum 和 Optimism 等多条 EVM 兼容链，以及 Solana 等其他链。
便捷的区块链查询: 提供区块链信息查询、地址解析、合约地址获取等功能，简化区块链数据访问。
高可靠节点服务: 基于 ZAN.top 的高性能节点服务，保证数据访问的稳定性和可靠性。
标准 MCP 协议: 完全遵循 Model Context Protocol 规范，确保与 MCP 客户端的兼容性。
可扩展架构: 支持轻松添加新的区块链工具和服务，方便功能扩展。

安装步骤

确保已安装 Node.js 和 npm 或 pnpm。

使用 npm 或 pnpm 安装 'zan-mcp-server'：

npm install zan-mcp-server
# 或
pnpm add zan-mcp-server

全局安装 (如果希望使用命令行工具 'zan-mcp-server')：

npm install -g zan-mcp-server

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 ZAN MCP Server。以下配置定义了一个名为 "zan" 的服务器，使用 'npx' 命令启动 'zan-mcp-server'，并通过 stdio 传输协议进行通信。

{
  "mcpServers": {
    "zan": {
      "command": "npx",
      "args": [
        "zan-mcp-server",
        "--stdio",
        "--api-key",
        "<zan_api_key>"
      ]
    }
  }
}

参数说明:

'server name': 服务器名称，这里设置为 "zan"，可以自定义。
'command': 启动服务器的命令，这里使用 'npx' 来运行本地安装的 'zan-mcp-server' 包。
'args': 传递给启动命令的参数列表。
- '--stdio': 指定使用 Stdio (标准输入输出) 作为 MCP 的传输协议。
- '--api-key': 必填，ZAN.top 节点服务的 API 密钥。请替换 '<zan_api_key>' 为您在 ZAN.top 申请的 API 密钥。

其他可选参数 (可以在 'args' 中添加):

'--sse': 如果需要使用 SSE (Server-Sent Events) 传输协议，请使用此参数。注意：当前仓库的 SSE 传输协议可能尚未完全实现，请谨慎使用。
'--port': 当使用 SSE 传输协议时，可以通过此参数指定服务器监听的端口号，默认为 3000。例如：'--sse --port 8080'
'--evm-private-key': EVM 链钱包私钥，用于支持需要私钥签名的 EVM 链操作。
'--solana-private-key': Solana 钱包私钥 (Base58 编码)，用于支持需要私钥签名的 Solana 链操作。
'-e, --endpoint': ZAN.top 节点服务的 API Endpoint，默认为 'https://api.zan.top'。如果需要使用自定义 Endpoint，可以通过此参数设置。

基本使用方法

启动服务器:

使用 NPX (无需全局安装):

npx zan-mcp-server --stdio --api-key YOUR_ZAN_API_KEY

请将 'YOUR_ZAN_API_KEY' 替换为您的 ZAN.top API 密钥。

使用全局安装 (如果已全局安装 'zan-mcp-server'):

zan-mcp-server --stdio --api-key YOUR_ZAN_API_KEY

同样，请替换 API 密钥。

配置 MCP 客户端:
- 根据您的 MCP 客户端软件的使用说明，配置 'mcpServers' 部分，填入上面提供的 JSON 配置信息。确保将 '<zan_api_key>' 替换为您的实际 API 密钥。
通过 MCP 客户端调用工具和资源:
- 配置完成后，MCP 客户端应该能够连接到 ZAN MCP Server。
- 您可以使用客户端提供的界面或命令来调用服务器提供的工具 (Tools) 和资源 (Resources)。
例如，调用 'evm_get_chain_info' 工具查询以太坊主网信息:
- 工具名称: 'evm_get_chain_info'
- 参数: '{"network": "eth/mainnet"}'
例如，访问 'evm://chains' 资源获取支持的 EVM 链列表:
- 资源 URI: 'evm://chains'

请参考 ZAN MCP Server 的 API 文档 (README.md 中的 API 部分) 了解更多可用的工具和资源，以及它们的具体使用方法和参数。

关键词