项目简介

XRP Ledger MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为 AI 模型提供访问和操作 XRP Ledger (XRPL) 区块链的标准化接口。通过此服务器,AI 模型可以安全、可控地与 XRPL 网络进行交互,实现丰富的区块链应用场景。

主要功能点

  • 账户管理:连接 XRPL 节点、获取账户信息、删除账户、设置账户属性等。
  • XRP 和代币操作:转移 XRP、获取代币元数据、查询代币余额、转移代币、授权代币使用、回收代币等。
  • NFT 操作:铸造 NFT、查看 NFT 元数据、验证 NFT 所有权、转移 NFT、获取 NFT 集合等。
  • 去中心化身份 (DID):创建、解析、更新和停用 DID。
  • AMM (自动化做市商) 操作:创建 AMM、向 AMM 存款、对 AMM 出价、投票、删除 AMM、从 AMM 回收资产等。
  • 支票 (Check) 操作:创建、兑现和取消支票。
  • 报价/DEX 操作:创建和取消报价。
  • 预言机 (Oracle) 操作:设置和删除预言机数据。
  • 支付通道:创建、充值和提取支付通道资金。
  • 托管 (Escrow):创建、完成和取消托管交易。
  • 信任线 (Trustlines):设置信任线。
  • 票据 (Ticketing):创建票据。

安装步骤

  1. 克隆仓库
    git clone https://github.com/RomThpt/mcp-xrpl.git
    cd mcp-xrpl/mcp-server
  2. 安装依赖
    npm install
  3. 构建项目
    npm run build

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 XRP Ledger MCP 服务器:

{
  "server name": "mcp-xrpl",
  "command": "node",
  "args": [
    "build/index.js"
  ],
  "description": "启动 XRP Ledger MCP 服务器,通过 stdio 接收 MCP 客户端请求。"
}
  • server name: 服务器名称,可以自定义,用于在客户端标识服务器。
  • command: 启动服务器的命令,这里使用 'node' 运行 JavaScript 文件。
  • args: 命令参数,指向编译后的服务器入口文件 'build/index.js'。
  • description: 服务器描述信息,方便用户理解服务器用途。

可选配置:

  • 环境变量 '.env': 可以在项目根目录下创建 '.env' 文件,设置 'XRPL_SEED' 环境变量,用于服务器自动连接到 XRPL Testnet。

    XRPL_SEED=sEdVoKkRRF8RsNYZ689NDeMyrijiCbg  # 替换为您自己的 Testnet 种子或移除以手动连接

基本使用方法

  1. 启动服务器

    在 'mcp-server' 目录下,运行以下命令启动 MCP 服务器:

    node build/index.js

    服务器将在 stdio 上运行,等待接收来自 MCP 客户端的请求。

  2. 使用 MCP 客户端连接

    配置 MCP 客户端,使其使用上述服务器配置信息连接到正在运行的 XRP Ledger MCP 服务器。客户端可以通过 JSON-RPC 协议调用服务器提供的各种工具,与 XRP Ledger 进行交互。

  3. 调用工具

    MCP 客户端可以使用服务器提供的工具,例如 'connect-to-xrpl'、'transfer-xrp'、'nft-mint' 等,来执行 XRPL 上的操作。工具的具体参数和使用方法可以参考代码仓库中的 'src/transactions' 目录下的各个工具文件。

安全提示

  • 默认情况下,服务器连接到 XRPL Testnet,用于开发和测试目的。
  • 如果需要连接到 Mainnet,请谨慎操作,并在充分测试后进行。

信息

分类

商业系统