使用说明

项目简介

Metis DeFi APY聚合器是一个基于Model Context Protocol (MCP) 的服务器实现，旨在为LLM应用提供Metis区块链上DeFi协议的收益（APY）数据。它从AAVE、Hercules Exchange 和 Netswap 等多个DeFi协议收集数据，并将其整合到一个统一的接口中，方便用户查询和分析。

主要功能点

多协议数据聚合: 从AAVE、Hercules Exchange 和 Netswap等多个DeFi协议抓取APY数据，并进行标准化处理。
收益数据查询: 提供多种工具（Tools）供MCP客户端调用，以查询不同DeFi协议的收益机会。
数据过滤与排序: 支持根据最低APY、协议名称、代币类型等条件过滤和排序收益数据。
总TVL查询: 可以查询所有支持协议的总价值锁定（TVL）。
MCP协议集成: 完全实现了Model Context Protocol，可以通过标准的JSON-RPC协议与LLM客户端进行通信。

安装步骤

克隆仓库

git clone https://github.com/MetisProtocol/mcp-yield.git
cd mcp-yield

安装依赖 确保你已经安装了 bun。如果没有安装，请先安装 bun。然后运行：
```
bun install
```
构建项目
```
bun run build
```

服务器配置

要将此MCP服务器添加到MCP客户端，您需要配置服务器启动命令。以下是一个示例 'mcpServers' 配置，你需要将其添加到你的MCP客户端配置中。请根据你的实际项目路径修改 'args' 中的路径。

"mcpServers": {
    "metis-yield-explorer": {
      "command": "node",
      "args": [
        "<your-project-directory>/mcp-yield/build/index.js"
      ]
    }
    // ... 其他 MCP 服务器配置 ...
}

配置参数说明:

'"metis-yield-explorer"': 服务器名称，可以自定义，用于在MCP客户端中标识该服务器。
'"command": "node"': 启动服务器的命令，这里使用 Node.js 运行 JavaScript 代码。
'"args"': 传递给 'node' 命令的参数，这里指定了服务器入口文件 'index.js' 的路径。请将 '<your-project-directory>' 替换为你本地 'mcp-yield' 仓库的实际路径。 例如，如果你的仓库在 '/Users/yourname/projects/mcp-yield'，则应将 '<your-project-directory>' 替换为 '/Users/yourname/projects'。

基本使用方法

配置完成后，在MCP客户端中，你可以通过以下工具 (Tools) 与该MCP服务器进行交互，查询DeFi收益数据：

'getAllPools': 获取所有支持协议的所有资金池信息。
'getPoolsByProtocol': 获取指定协议的资金池信息，例如 "AAVE" 或 "Hercules"。
'getTopApyPools': 获取APY最高的资金池，默认返回前10个。
'getPoolsByToken': 获取包含特定代币的资金池，例如 "METIS"。
'getHighApyPools': 获取APY高于指定阈值的资金池，默认阈值为10%。
'getTotalTvl': 获取所有支持协议的总价值锁定（TVL）以及按协议划分的TVL。
'get-lending-yields': 综合查询借贷收益机会，可以根据最小APY、协议、代币和结果数量进行过滤。
'get-total-tvl': 获取所有协议的总价值锁定 (TVL)。

示例查询 (在MCP客户端中调用Tool):

查询AAVE协议中APY大于5%的借贷池 (使用 'get-lending-yields' 工具):

{
  "name": "get-lending-yields",
  "args": {
    "minApy": 5,
    "protocol": "AAVE"
  }
}

获取所有协议的总TVL (使用 'get-total-tvl' 工具):

{
  "name": "get-total-tvl"
}

请参考仓库 'README.md' 文件和 'src/index.ts' 中的工具定义，获取更详细的工具参数和使用方法。

关键词