MCP Xrpl

🚀 MCP-XRPL プロジェクトガイド

MCP-XRPLは、Model Context Protocol (MCP)に基づくプロトコルアダプタで、XRP Ledgerエコシステムをサポートしています。これはMCPに橋渡しを提供し、開発者がXRPLネットワークと簡単にやり取りできるようにします。

🚀 クイックスタート

MCP-XRPLは、XRP LedgerエコシステムとModel Context Protocol (MCP) を接続するプロトコルアダプタです。このガイドを通じて、プロジェクトのセットアップ、使用方法、開発に関する情報を提供します。

📦 インストール

依存関係のインストール

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: リソースURIの生成に使用するカスタムMCPサービスアドレスを設定します。

セキュリティに関する注意事項

• 本番環境のウォレットシードを直接使用しないでください。
• 機能の検証はテスト環境で行うことをおすすめします。
• 通信のセキュリティを確保するために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を使用してください。

プロジェクトへの貢献

コミュニティからのコード貢献を歓迎します！標準的な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への関心とサポートに感謝します！さらなる支援が必要な場合は、プロジェクトメンテナンスチームにお問い合わせください。