MCP Xrpl

🚀 MCP-XRPL 項目指南

MCP-XRPL 是一個基於 Model Context Protocol (MCP) 的協議適配器，支持 XRP Ledger 生態系統。它為 MCP 搭建了一座橋樑，讓開發者能夠輕鬆與 XRPL 網絡進行交互。

🚀 快速開始

MCP-XRPL 作為基於 MCP 的協議適配器，可助力開發者便捷地與 XRPL 網絡交互。下面為您介紹如何快速開啟項目。

✨ 主要特性

支持的 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

📦 安裝指南

安裝依賴

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 確保通信安全

開發指南

添加新功能模塊

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。

項目貢獻

歡迎社區貢獻代碼！請遵循標準的 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 的關注與支持！如需進一步幫助，請隨時聯繫項目維護團隊。