mcp-xrpl

🚀 MCP-XRPL 项目指南

MCP-XRPL 是一款基于 Model Context Protocol (MCP) 的协议适配器，专门服务于 XRP Ledger 生态系统。它搭建起了 MCP 与 XRPL 网络之间的桥梁，让开发者能够轻松地与 XRPL 网络进行交互。

🚀 快速开始

MCP-XRPL 为开发者提供了便捷的方式来与 XRPL 网络交互。按照以下步骤，你可以快速启动项目。

📦 安装指南

安装依赖

运行以下命令安装所需的依赖：

npm install @modelcontextprotocol/sdk xrpl dotenv zod

克隆仓库

使用以下命令克隆项目仓库并进入项目目录：

git clone git@github.com:yourusername/mcp-xrpl.git
cd mcp-xrpl

配置环境变量

创建一个 .env 文件，并添加以下内容：

WALLET_SEED=your_wallet_seed_here
DEFAULT_NETWORK=testnet # 可选，默认为 testnet
MCP_ENDPOINT=http://localhost:3000 # 可选，自定义 MCP 服务地址

启动项目

运行以下命令启动项目：

npm run dev

📚 详细文档

配置文件说明

网络配置

• DEFAULT_NETWORK：设置默认网络（mainnet 或 testnet），默认为 testnet。
• MCP_ENDPOINT：自定义 MCP 服务地址，用于资源 URI 的生成。

安全注意事项

⚠️ 重要提示

• 不要直接使用生产环境的 wallet seed。
• 建议在测试环境中进行功能验证。
• 使用 HTTPS 确保通信安全。

核心功能

支持的 XRPL 资源

1. 账户信息
   • 获取账户余额：xrpl://{network}/account/{address}
   • 获取 XRP 余额：xrpl://{network}/account/{address}/balance
2. 交易记录
   • 查询交易详情：xrpl://{network}/tx/{tx_hash}
3. 代币信息
   • 获取代币详情：xrpl://{network}/token/{currency}/{issuer}
   • 查询代币余额：xrpl://{network}/token/{currency}/{issuer}/balanceOf/{address}
4. NFT 信息
   • 查看 NFT 详情：xrpl://{network}/nft/{tokenID}
   • 获取拥有者信息：xrpl://{network}/nft/{tokenID}/owner

开发指南

添加新功能模块

1. 在 src/transactions/ 目录下创建新的 TypeScript 文件。
2. 导入服务器实例：import { server } from '../server/server.js'。
3. 定义新工具：server.tool()，并在 src/index.ts 中导入。

代码结构

mcp-xrpl/
├── src/
│   ├── core/                # 核心工具与服务
│   ├── transactions/       # 各类交易处理逻辑
│   └── server/             # MCP 适配器服务器端
└── package.json            # 项目依赖管理文件

安全注意事项

⚠️ 重要提示

• 使用环境变量管理敏感配置。
• 建议在生产环境中启用身份验证。
• 确保网络通信使用 HTTPS。

✨ 主要特性

• 提供了 MCP 与 XRPL 网络之间的桥梁，方便开发者交互。
• 支持多种 XRPL 资源的查询，包括账户信息、交易记录、代币信息和 NFT 信息。

🤝 项目贡献

欢迎社区贡献代码！请遵循标准的 Git 工作流程：

1. 创建功能分支：git checkout -b feature/new-feature。
2. 提交代码变更：git add .; git commit -m "添加新功能"。
3. 提交到远程仓库：git push origin feature/new-feature。
4. 创建 Pull Request。

贡献者名单

• Alice Smith - 项目负责人
• Bob Johnson - 核心开发成员
• Charlie Brown - 测试工程师

📄 许可证

MCP-XRPL 采用 MIT 协议，具体内容请查阅 LICENSE 文件。

感谢您对 MCP-XRPL 的关注与支持！如需进一步帮助，请随时联系项目维护团队。