xrpl mcp

by RomThpt
Verified
MIT License
3
  • Linux
  • Apple

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Used for environment variable management and configuration, allowing the server to securely store sensitive data like wallet seeds and network selection.

  • Serves as the runtime environment for the MCP server, with version 18.0.0 or higher required as a prerequisite.

  • Implementation language for the MCP server, providing type safety and modern language features.

XRP 元帳モデルコンテキストプロトコルサーバー

ライセンス: MIT | XRPL Networks | TypeScript | xrpl.js

XRP Ledgerエコシステムにブロックチェーンサービスを提供する包括的なモデルコンテキストプロトコル(MCP)サーバー。このサーバーにより、AIエージェントは統一されたインターフェースを介してXRPL MainNet、TestNet、DevNetとやり取りできるようになります。

📋 目次

🔭 概要

MCP XRPLサーバーは、モデルコンテキストプロトコルを活用して、AIエージェントにXRP Ledgerサービスを提供します。以下の幅広いサービスをサポートしています。

  • 元帳の状態(残高、取引、アカウント情報など)の読み取り
  • スマートコントラクトとのやり取り(Hooks経由)
  • XRPおよび発行トークンの転送
  • トークンのメタデータと残高の照会
  • 分散識別子(DID)の管理
  • XRPLでのNFTの活用
  • 自動マーケットメーカー(AMM)の運用
  • 支払いチャネル、エスクロー、小切手
  • Oracleデータ操作
  • トラストライン管理

すべてのサービスは、MCP ツールとリソースの一貫したインターフェースを通じて公開されるため、AI エージェントは XRPL 機能を簡単に検出して使用できます。

✨ 特徴

アカウント管理

  • XRPL ネットワーク (MainNet、TestNet、DevNet) に接続する
  • アカウント情報の取得
  • アカウントプロパティ管理
  • 預金の事前承認
  • 定期的な鍵管理

XRPとトークンの運用

  • アカウント間でXRPを転送する
  • トークンのメタデータ(名前、シンボル、小数点、供給)を取得する
  • トークン残高を確認する
  • アドレス間でトークンを転送する
  • トークン支出を承認する
  • トークンの回収

NFTオペレーション

  • XRP元帳でNFTを発行する
  • NFTメタデータを表示
  • NFTの所有権を確認する
  • アドレス間でNFTを転送する
  • NFTコレクションを入手する

分散識別子(DID)

  • XRPLでDIDを作成する
  • DIDを解決する
  • DID文書を更新する
  • DIDを非アクティブ化する

AMMオペレーション

  • 自動マーケットメーカーを作成する
  • AMMへの入金
  • AMMに入札する
  • AMMパラメータに投票する
  • AMMを削除する
  • AMMからの資産の回収

操作の確認

  • 小切手を作成する
  • 現金小切手
  • チェックをキャンセルする

オファー/DEXオペレーション

  • オファーを作成する
  • オファーをキャンセルする

Oracleオペレーション

  • Oracleデータの設定
  • Oracleデータを削除する

支払いチャネル

  • 支払いチャネルを作成する
  • 資金支払いチャネル
  • 支払いチャネルからの請求

預託

  • エスクローを作成する
  • エスクローを完了する
  • エスクローをキャンセルする

トラストライン

  • 信頼ラインの設定と管理

発券業務

  • 取引処理用のチケットを作成する

🌐 サポートされているネットワーク

  • メインネット: プロダクションXRP元帳ネットワーク
  • TestNet : 開発用のテストネットワーク
  • DevNet : 実験的な機能の開発ネットワーク

🛠️ 前提条件

  • 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 Inspectorをご利用いただけます。

📚 APIリファレンス

ツール

サーバーはエージェントに次の MCP ツールを提供します。

アカウント管理

ツール名説明主なパラメータ
connect-to-xrplシードを使用してXRP Ledgerに接続する種子、ネットワーク
get-account-infoアカウント情報を取得するアドレス、ネットワーク
delete-accountXRPLアカウントを削除する秘密鍵、宛先、ネットワーク
set-account-propertiesアカウントプロパティを設定する秘密鍵、プロパティ、ネットワーク
deposit-preauthデポジットの事前承認秘密鍵、承認、ネットワーク
set-regular-keyアカウントの通常キーを設定する秘密鍵、通常鍵、ネットワーク

XRPとトークンの運用

ツール名説明主なパラメータ
transfer-xrpアカウントにXRPを送信する秘密鍵、宛先、金額、ネットワーク
get-token-metadataトークンのメタデータを取得するトークンアドレス、ネットワーク
check-token-balanceトークン残高を確認するトークンアドレス、オーナーアドレス、ネットワーク
transfer-tokenトークンの転送秘密鍵、トークンアドレス、宛先、金額、ネットワーク
approve-token-spendingトークン支出を承認する秘密鍵、トークンアドレス、制限、ネットワーク
token-clawbackクローバックトークン秘密鍵、トークンアドレス、送信元、金額、ネットワーク

NFTオペレーション

ツール名説明主なパラメータ
nft-mintNFTを作成する秘密鍵、URI、フラグ、ネットワーク
get-nft-infoNFTメタデータを取得するトークンID、ネットワーク
check-nft-ownershipNFTの所有権を確認するトークンID、所有者アドレス、ネットワーク
transfer-nftNFTを転送する秘密鍵、トークンID、ネットワークへ
get-nft-collectionコレクションでNFTを入手するアドレス、ネットワーク

DIDオペレーション

ツール名説明主なパラメータ
create-didDIDを作成する秘密鍵、データ、ネットワーク
resolve-didDIDを解決するした、ネットワーク
update-didDIDを更新する秘密鍵、did、データ、ネットワーク
deactivate-didDIDを非アクティブ化する秘密鍵、did、ネットワーク

AMMオペレーション

ツール名説明主なパラメータ
amm-createAMMを作成する秘密鍵、資産、ネットワーク
amm-depositAMMへの入金秘密鍵、ammID、資産、ネットワーク
amm-bidAMMに入札する秘密鍵、ammID、入札、ネットワーク
amm-voteAMMパラメータに投票する秘密鍵、ammID、投票、ネットワーク
amm-deleteAMMを削除する秘密鍵、ammID、ネットワーク
amm-clawbackAMMからの資産の回収秘密鍵、ammID、資産、ネットワーク

リソース

サーバーは、次の MCP リソース URI を通じて XRPL データを公開します。

元帳リソース

リソースURIパターン説明
xrpl://{network}/ledger/current現在の元帳情報
xrpl://{network}/ledger/{ledger_index}インデックスによる元帳
xrpl://{network}/account/{address}アカウント情報
xrpl://{network}/account/{address}/balanceアカウントXRP残高
xrpl://{network}/tx/{tx_hash}取引の詳細

トークンリソース

リソースURIパターン説明
xrpl://{network}/token/{currency}/{issuer}トークン情報
xrpl://{network}/token/{currency}/{issuer}/balanceOf/{address}トークン残高
xrpl://{network}/nft/{tokenID}NFT情報
xrpl://{network}/nft/{tokenID}/ownerNFTの所有権情報

🔒 セキュリティに関する考慮事項

  • ウォレットシードはトランザクションの署名にのみ使用され、安全に保管する必要があります。
  • 本番環境での使用のために追加の認証メカニズムを実装することを検討する
  • 高価値サービスの場合は確認手順を追加することを検討してください
  • 開発中の安全性を確保するために、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. src/transactions/の下の適切なディレクトリに新しい TypeScript ファイルを作成します。
  2. server/server.jsからサーバーをインポートします。
  3. server.tool()を使用してツールを定義する
  4. src/index.tsにツールをインポートします。

プロジェクトの依存関係

📄 ライセンス

このプロジェクトは、MIT ライセンスの条件に基づいてライセンスされます。

⚠️免責事項

このソフトウェアは教育および開発目的のみに提供されています。自己責任でご使用ください。メインネットで実際のXRPを使用する前に、必ずテストネットで十分なテストを行ってください。

-
security - not tested
A
license - permissive license
-
quality - not tested

XRP Ledgerとの統合を提供するCPサーバー。このサーバーにより、AIアシスタントはXRP Ledger上のアカウント情報、取引履歴、ネットワークデータにアクセスでき、台帳オブジェクトのクエリ、取引の送信、ネットワークの監視などの機能も利用できます。

  1. 📋 Contents
    1. 🔭 Overview
      1. ✨ Features
        1. Account Management
        2. XRP and Token Operations
        3. NFT Operations
        4. Decentralized Identifier (DID)
        5. AMM Operations
        6. Check Operations
        7. Offer/DEX Operations
        8. Oracle Operations
        9. Payment Channels
        10. Escrow
        11. Trustlines
        12. Ticketing
      2. 🌐 Supported Networks
        1. 🛠️ Prerequisites
          1. 📦 Installation
            1. ⚙️ Server Configuration
              1. 🚀 Usage
                1. Starting the Server
                2. Connecting to the Server
              2. 📚 API Reference
                1. Tools
                2. Resources
              3. 🔒 Security Considerations
                1. 📁 Project Structure
                  1. 🛠️ Development
                    1. Adding New Tools
                    2. Project Dependencies
                  2. 📄 License
                    1. ⚠️ Disclaimer
                      ID: aifp64y484