项目简介

这是一个基于 Model Context Protocol (MCP) 构建的服务器实现,它作为 LLM 客户端与 NFTGo Developer API 之间的桥梁。通过此服务器,LLM 可以标准化的方式访问 NFTGo 提供的丰富的 NFT 数据和区块链信息。

主要功能点

该服务器通过 MCP 协议向客户端提供以下功能:

  • API 文档资源 (Resources): 暴露 NFTGo Developer API 的 OpenAPI 规范作为资源,LLM 可以通过读取这些资源来了解可用的 API 端点及其详细参数。
  • API 调用工具 (Tools): 提供工具允许 LLM 根据 API 规范构造和执行对 NFTGo API 的 HTTP 请求,获取实时的 NFT 数据、市场统计、交易历史等信息。
  • 能力声明: 向客户端声明其提供的资源和工具能力。

该服务器不包含 Prompt 模板功能。使用此服务器需要一个有效的 NFTGo Developer API Key。

安装步骤

该服务器是作为一个 npm 包发布的,您需要 Node.js 和 pnpm (或 npm/yarn) 来安装和运行。

  1. 确保您已安装 Node.js 和 pnpm。

  2. 运行以下命令安装项目依赖并构建:

    pnpm install
    pnpm build

服务器配置 (供 MCP 客户端使用)

MCP 服务器通常由 MCP 客户端(如 Claude Desktop 或其他支持 MCP 的应用)启动和管理。客户端需要配置如何启动此服务器。以下是配置示例(请注意这部分是给客户端应用的配置文件看的,您无需手动运行这些命令):

{
  "mcpServers": {
    "nftgoapi": {
      "command": "npx",
      "args": ["-y", "@nftgo/mcp-nftgo-api", "您的-NFTGO-API-KEY"]
    }
  }
}
  • 'nftgoapi': 这是您为此 MCP 服务器实例指定的名称,客户端会用这个名称来引用它。
  • 'command': 启动服务器的可执行命令,这里使用 'npx' 来运行已安装的 npm 包。
  • 'args': 传递给命令的参数。'"-y", "@nftgo/mcp-nftgo-api"' 用于执行 npm 包, '"您的-NFTGO-API-KEY"' 需要替换为您从 NFTGo 获取的实际 API Key。请务必将 '"您的-NFTGO-API-KEY"' 替换为您自己的 API Key。

将上述配置添加到您的 MCP 客户端(例如 'claude_desktop_config.json')的相应部分,并用您的真实 API Key 替换占位符。

基本使用方法 (通过 MCP 客户端)

当您配置好并在 MCP 客户端中成功启动此服务器后,LLM 客户端将能够发现并使用它提供的功能。

  1. 发现功能: LLM 客户端会通过 MCP 协议请求服务器的能力列表(工具和资源)。
  2. 理解功能: LLM 可以通过读取作为资源暴露的 API 文档来理解各个 API 端点的用途、所需参数和返回结构。
  3. 调用工具: LLM 可以使用提供的工具(如 'request' 工具)来调用特定的 NFTGo API 端点,并传入必要的参数(例如,要查询的合约地址、代币 ID、时间范围等)。
  4. 获取结果: 服务器会执行 API 调用,并将返回的数据格式化后通过 MCP 响应发送回 LLM 客户端。LLM 客户端可以解析这些数据并在与用户的交互中使用。

例如,LLM 可能会先使用 'api-documentation' 工具获取所有可用 API 端点列表,然后使用 'api-path-schema' 获取某个特定端点(如获取某个 NFT 详情的 API)的详细参数说明,最后使用 'request' 工具调用该 API 并传入用户指定的合约地址和代币 ID。

信息

分类

网页与API