xrpl MCP

XRP分类账模型上下文协议服务器


许可证：MIT | XRPL Networks | TypeScript | XRPL.js

一个全面的模型上下文协议（MCP）服务器，为XRP Ledger生态系统提供区块链服务。该服务器使AI代理能够通过统一的接口与XRPL MainNet、TestNet和DevNet进行交互。

📋 目录

• 概述
• 特性
• 支持的网络
• 先决条件
• 安装
• 服务器配置
• 用法
• api参考
• 安全考虑
• 项目结构
• 发展
• 许可证

🔭 概述

MCP XRPL服务器利用模型上下文协议为AI代理提供XRP分类账服务。它支持广泛的服务，包括：

• 读取分类账状态（余额、交易、账户信息等）
• 与智能合约交互（通过Hooks）
• 转移XRP和已发行代币
• 查询令牌元数据和余额
• 管理去中心化标识符（DID）
• 在XRPL上与NFT合作
• 自动做市商（AMM）运营
• 支付渠道、托管和支票
• Oracle数据操作
• 信任线管理

所有服务都通过MCP工具和资源的一致接口公开，使AI代理能够轻松发现和使用XRPL功能。

✨ 特性

账户管理

• 连接到XRPL网络（主网、测试网、开发网）
• 账户信息检索
• 账户财产管理
• 存款预授权
• 定期密钥管理

XRP和代币运营

• 在账户之间转移XRP
• 获取令牌元数据（名称、符号、小数、供应）
• 检查代币余额
• 在地址之间转移令牌
• 批准代币支出
• 代币回拨

NFT操作

• XRP分类账上的Mint NFT
• 查看NFT元数据
• 验证NFT所有权
• 在地址之间传输NFT
• 获取NFT收藏

去中心化标识符（DID）

• 在XRPL上创建DID
• 解决DID
• 更新DID文档
• 停用DID

AMM操作

• 创建自动化做市商
• 向AMM存款
• 在AMM上出价
• 对AMM参数进行投票
• 删除AMM
• 从AMM追回资产

检查操作

• 创建检查
• 现金支票
• 取消检查

报价/DEX运营

• 创建优惠
• 取消优惠

Oracle运营

• 设置oracle数据
• 删除oracle数据

支付渠道

• 创建支付渠道
• 资金支付渠道
• 付款渠道索赔

托管

• 创建escrows
• 完成escrows
• 取消escrows

信任线

• 设置和管理信任线

票务

• 创建交易处理票

🌐 支持的网络

• 主网：生产XRP分类账网络
• 测试网：开发测试网络
• 国际信息发展组织：实验特征开发网络

🛠️ 先决条件

• Node.js 18.0.0或更高版本

📦 安装

# Clone the repository
git clone https://github.com/yourusername/mcp-xrpl.git
cd mcp-xrpl

# Install dependencies
npm install

# Build the project
npm run build

⚙️ 服务器配置

创建一个 .env 项目根目录中的文件，包含以下变量：

# Optional: XRPL wallet seed for automatic connection
# If not provided, you can connect using the connect-to-xrpl tool
DEFAULT_SEED=sEdVoKkRRF8RsNYZ689NDeMyrijiCbg  # Example - replace with your own or remove

# Network selection (default is "testnet")
XRPL_NETWORK=testnet  # Options: mainnet, testnet, devnet

🚀 用法

启动服务器

# Start the server in stdio mode (for CLI tools)
npm start

连接到服务器

使用任何兼容MCP的客户端连接到此MCP服务器。对于测试和调试，您可以使用MCP检查器。

📚 api参考

工具

服务器为代理提供以下MCP工具：

账户管理

XRP和代币运营

NFT操作

DID操作

AMM操作

资源

服务器通过以下MCP资源URI公开XRPL数据：

分类账资源

代币资源

🔒 安全考虑

• 钱包种子仅用于交易签名，应保持安全
• 考虑为生产使用实施额外的身份验证机制
• 对于高价值服务，考虑添加确认步骤
• 默认操作在TestNet上执行，以确保开发过程中的安全
• 使用环境变量进行敏感配置

📁 项目结构

mcp-xrpl/
├── src/
│   ├── core/                # Core utilities and services
│   │   ├── constants.ts     # XRPL network URLs and other constants
│   │   ├── state.ts         # State management for connected wallet
│   │   ├── utils.ts         # Helper functions
│   │   └── services/        # Service modules
│   ├── server/              # MCP server implementation
│   ├── transactions/        # XRPL transaction implementation
│   │   ├── token/           # Token-related transactions
│   │   ├── nft/             # NFT-related transactions
│   │   ├── did/             # DID-related transactions
│   │   ├── amm/             # AMM-related transactions
│   │   ├── check/           # Check-related transactions
│   │   ├── offer/           # Offer-related transactions
│   │   ├── oracle/          # Oracle-related transactions
│   │   ├── payment/         # Payment-related transactions
│   │   ├── escrow/          # Escrow-related transactions
│   │   └── trust/           # Trust line-related transactions
│   └── index.ts             # Entry point
├── build/                   # Compiled JavaScript output
├── package.json
├── package-lock.json
└── tsconfig.json

🛠️ 发展

添加新工具

要添加新工具，请执行以下操作：

1. 在下面的相应目录中创建一个新的TypeScript文件 src/transactions/
2. 从导入服务器 server/server.js
3. 使用定义工具 server.tool()
4. 将工具导入 src/index.ts

项目依赖项

• @modelcontextprotocol/sdk：MCP SDK
• xrpl：XRP Ledger JavaScript/TypeScript API
• dotenv：环境变量管理
• zod：TypeScript第一个模式声明和验证

📄 许可证

本项目根据MIT许可证条款获得许可。

⚠️ 免责声明

本软件仅用于教育和开发目的。使用它的风险由你自己承担。在使用真正的XRP在主网上使用之前，始终在测试网上进行彻底测试。