使用说明

项目简介

educhain-ai-agent-kit 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在桥接大型语言模型 (LLM) 与 EDUCHAIN 区块链生态系统，特别是 SailFish 去中心化交易所 (DEX)。它允许 LLM 客户端（如 Claude）通过标准化的 MCP 协议，安全便捷地查询 EDUCHAIN 上的数据，并调用工具执行交易操作。

主要功能点

资源访问:
- 提供 SailFish DEX 的概览信息，如总锁仓价值 (TVL)、交易量等。
- 查询指定代币和流动性池的详细信息和历史数据。
工具调用:
- 代币和池信息查询工具: 获取代币价格、信息、顶级代币/池列表、TVL 和交易量等。
- 钱包操作工具: 查询 EDU 和 ERC20 代币余额、NFT 余额、发送 EDU 和 ERC20 代币等。
- Swap 交易工具: 获取 Swap 报价、执行代币 Swap 交易 (包括 EDU 与其他代币的兑换)、Wrap/Unwrap EDU 等。
- 套利操作工具: 获取中心化交易所 (CEX) 的 EDU 市场数据，检查 CEX 与 SailFish DEX 之间的套利机会，并可配置外部市场数据 API。
配置管理:
- 动态设置和获取区块链 RPC URL。
- 更新和获取外部市场数据 API 的配置。

安装步骤

安装 Node.js: 确保你的系统已安装 Node.js 运行环境。
克隆仓库: 使用 Git 克隆仓库 'https://github.com/SailFish-Finance/educhain-ai-agent-kit' 到本地。
安装依赖: 在仓库根目录下运行命令 'npm install' 安装项目依赖。
构建项目: 运行命令 'npm run build' 构建项目，生成可执行的 JavaScript 代码。

服务器配置

为了让 MCP 客户端（例如 Claude）连接到 educhain-ai-agent-kit 服务器，你需要在 MCP 客户端的配置文件中添加服务器配置信息。以下是根据仓库信息生成的配置示例，你需要根据实际情况修改路径：

{
  "mcpServers": {
    "sailfish": { # 服务器名称，客户端使用时需要指定此名称
      "command": "node", # 启动服务器的命令，这里使用 node.js 运行时
      "args": ["/path/to/educhain-ai-agent-kit/build/index.js"], # 服务器启动参数，指向构建后的 index.js 文件，请替换为你的实际路径
      "env": { # 环境变量配置
        "RPC_URL": "https://your-edu-rpc-url.com" # EDUCHAIN 区块链 RPC URL，请替换为你自己的 RPC URL
      }
    }
  }
}

请注意:

'/path/to/educhain-ai-agent-kit' 需要替换为你本地仓库的实际路径。
'https://your-edu-rpc-url.com' 需要替换为可用的 EDUCHAIN 区块链 RPC URL。你可以从 Gelato Network 等服务商获取。
'sailfish' 是服务器的名称，在客户端调用工具或资源时需要使用此名称。

基本使用方法

启动服务器: 在仓库根目录下，确保已经构建项目 ('npm run build') 后，MCP 服务器会在客户端连接时自动启动。你无需手动运行服务器。

客户端调用: 在支持 MCP 协议的客户端（如 Claude）中使用 'use_mcp_tool' 函数调用服务器提供的工具，或使用资源 URI 访问资源。

工具调用示例:

// 获取代币价格
use_mcp_tool("sailfish", "get_token_price", {
  "tokenId": "0x836d275563bAb5E93Fd6Ca62a95dB7065Da94342" // USDC 代币地址
});

// 获取 Swap 报价
use_mcp_tool("sailfish", "get_swap_quote", {
  "tokenIn": "0xd02E8c38a8E3db71f8b2ae30B8186d7874934e12", // WEDU 地址
  "tokenOut": "0x836d275563bAb5E93Fd6Ca62a95dB7065Da94342", // USDC 地址
  "amountIn": "10"
});

// 执行代币 Swap 交易 (需要私钥)
use_mcp_tool("sailfish", "swap_tokens", {
  "privateKey": "YOUR_PRIVATE_KEY", // 替换为你的私钥，注意安全！
  "tokenIn": "0xd02E8c38a8E3db71f8b2ae30B8186d7874934e12", // WEDU 地址
  "tokenOut": "0x836d275563bAb5E93Fd6Ca62a95dB7065Da94342", // USDC 地址
  "amountIn": "10",
  "slippagePercentage": 0.5
});

资源访问示例:

// 获取 SailFish DEX 概览信息
read_mcp_resource("sailfish://overview");

// 获取指定代币信息
read_mcp_resource("sailfish://token/0x836d275563bAb5E93Fd6Ca62a95dB7065Da94342"); // USDC 代币地址

// 获取指定流动性池信息
read_mcp_resource("sailfish://pool/0x00..."); // 流动性池地址

重要安全提示:

私钥安全: 在进行交易操作时需要提供私钥，请务必妥善保管你的私钥，避免泄露。在生产环境中使用时，请考虑更安全的私钥管理方案。
交易风险: 区块链交易存在风险，请谨慎操作，并充分了解交易参数和可能产生的费用。

关键词