使用说明

项目简介

GoldRush MCP Server 是一个 MCP (Model Context Protocol) 服务器,旨在桥接 Covalent GoldRush API 与 LLM (大型语言模型) 客户端。它允许 LLM 客户端通过标准化的 MCP 协议,安全、便捷地访问区块链数据和调用相关功能,从而增强 LLM 应用的上下文感知和实用性。

主要功能点

  • 资源 (Resources) 托管与管理: 提供链信息、报价货币、链状态等链上数据的标准化访问接口。
  • 工具 (Tools) 注册与执行: 暴露 Covalent GoldRush API 的功能,如获取交易信息、账户余额、NFT 数据等,供 LLM 客户端按需调用。
  • 基于 JSON-RPC 协议通信: 采用 MCP 标准的 JSON-RPC 协议与客户端进行通信,确保兼容性和互操作性。
  • 支持 Stdio 传输协议: 使用 Stdio 作为默认传输协议,易于集成和部署。
  • 模块化架构: 采用模块化设计,服务和功能清晰划分,易于维护和扩展。
  • 丰富的工具集: 内置 25 个常用的区块链数据查询和分析工具,覆盖比特币和以太坊等主流网络。
  • 动态与静态资源: 提供实时更新的动态资源(如链状态)和静态配置资源(如支持的链列表和货币)。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/covalenthq/goldrush-mcp-server.git
    cd goldrush-mcp-server
  2. 安装依赖:
    npm install
  3. 构建项目:
    npm run build
  4. 设置 GOLDRUSH_API_KEY 环境变量: 你需要一个 Covalent GoldRush API 密钥。访问 https://goldrush.dev/platform/auth/register/ 注册并获取。 在你的终端中设置环境变量,例如 (Linux/macOS):
    export GOLDRUSH_API_KEY=YOUR_API_KEY_HERE
    或者 (Windows):
    set GOLDRUSH_API_KEY=YOUR_API_KEY_HERE

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令才能连接。以下是针对不同 MCP 客户端的配置示例,你需要根据你使用的客户端进行配置。

Claude Desktop 配置 (claude_desktop_config.json):

{
    "mcpServers": {
        "goldrush": {
            "command": "npx",
            "args": ["-y", "@covalenthq/goldrush-mcp-server"],
            "env": {
                "GOLDRUSH_API_KEY": "YOUR_API_KEY_HERE"
            }
        }
    }
}
  • 'server name': 'goldrush' (服务器名称,客户端内唯一标识)
  • 'command': 'npx' (启动命令,这里使用 npx 运行 npm 包)
  • 'args': '["-y", "@covalenthq/goldrush-mcp-server"]' (命令参数,'-y' 表示自动确认安装包,'@covalenthq/goldrush-mcp-server' 是要运行的 npm 包名)
  • 'env': '{"GOLDRUSH_API_KEY": "YOUR_API_KEY_HERE"}' (环境变量配置,'GOLDRUSH_API_KEY' 用于传递你的 Covalent API 密钥)

Cursor 配置 (~/.cursor/mcp.json 或 .cursor/mcp.json):

{
    "mcpServers": {
        "goldrush": {
            "command": "npx",
            "args": ["-y", "@covalenthq/goldrush-mcp-server"],
            "env": {
                "GOLDRUSH_API_KEY": "YOUR_API_KEY_HERE"
            }
        }
    }
}

配置参数与 Claude Desktop 相同。

Claude Code CLI 配置:

claude mcp add goldrush -e GOLDRUSH_API_KEY=<YOUR_API_KEY_HERE> -- npx @covalenthq/goldrush-mcp-server

该命令会自动配置服务器,并设置环境变量。

Windsurf 配置 (~/.codeium/windsurf/mcp_config.json):

{
    "mcpServers": {
        "goldrush": {
            "command": "npx",
            "args": ["-y", "@covalenthq/goldrush-mcp-server"],
            "env": {
                "GOLDRUSH_API_KEY": "YOUR_API_KEY_HERE"
            }
        }
    }
}

配置参数与 Claude Desktop 相同。

基本使用方法

  1. 启动 MCP 服务器: 在项目根目录下运行:

    npm run start

    这将启动 GoldRush MCP Server,并通过标准输入/输出 (STDIO) 与 MCP 客户端通信。

  2. 在 MCP 客户端中使用: 根据你使用的 MCP 客户端(如 Claude、Cursor、Windsurf 等),按照其文档配置并连接到 'goldrush' 服务器。配置完成后,你就可以在客户端中发现并使用 GoldRush MCP Server 提供的工具和资源了。

    例如,在支持工具调用的 LLM 应用中,你可以指示 LLM 使用 'token_balances' 工具查询指定地址的代币余额,或者使用 'historical_token_prices' 工具获取代币的历史价格数据。

    具体工具和资源的使用方法,请参考仓库 README.md 中的 "Tools" 和 "Resources" 章节,以及 Model Context Protocol 官方文档

信息

分类

网页与API