Xrpl MCP Service

🚀 XRPL MCP Service

An Model Context Protocol (MCP) server that offers comprehensive access to the XRP Ledger (XRPL). This service enables AI models to interact with the XRPL through standardized endpoints.

🚀 Quick Start

Setup

1. Create a .env file:

XRPL_NODE_URL=https://xrplcluster.com

2. Install dependencies:

pip install xrpl-py fastapi uvicorn python-dotenv

3. Start the server:

uvicorn main:app --host 0.0.0.0 --port 8000 --reload

✨ Features

Account Information

• xrpl_account_info - Basic account details
• xrpl_account_balances - XRP and token balances (in human-readable format)
• xrpl_account_lines - Trust lines
• xrpl_account_offers - Active trade offers
• xrpl_account_nfts - NFT holdings
• xrpl_account_tx - Transaction history

Decentralized Exchange

• xrpl_order_book - View the order book for a currency pair
• xrpl_market_price - Get the current market price
• xrpl_amm_info - Information on automated market makers

NFT Operations

• xrpl_nft_offers - View NFT purchase/sale offers

Trust Lines and Payments

• xrpl_set_trust_line - Establish a new trust line
• xrpl_remove_trust_line - Remove an existing trust line
• xrpl_payment_channels - Payment channel information
• xrpl_find_path - Find a payment path
• xrpl_deposit_auth - Check payment authorization

System

• xrpl_server_info - Node status and information
• xrpl_submit_tx - Submit a signed transaction

💻 Usage Examples

Get Account Information

POST /call-tool/xrpl_account_info
{
  "account": "rsuUjfWxrACCAwGQDsNeZUhpzXf1n1NK5Z"
}

Get Account Balances

POST /call-tool/xrpl_account_balances
{
  "account": "rsuUjfWxrACCAwGQDsNeZUhpzXf1n1NK5Z"
}

Set Trust Line

POST /call-tool/xrpl_set_trust_line
{
  "account": "alice",
  "trustee": "bob",
  "amount": "100"
}

Get Order Book

POST /call-tool/xrpl_order_book
{
  "order_id": "12345"
}

📚 Documentation

Project Structure

• main.py - Entry point for the FastAPI application
• xrpl_tools.py - XRPL tools and functions
• templates/ - HTML template files
• static/ - Static resource files

Key Components

• XrplClient - A client class for interacting with the XRPL network
• TrustLineManager - A manager for handling trust line operations
• PaymentChannel - A class that supports payment channel functionality
• OrderBook - An implementation of the order book data structure

Future Enhancement Plans

1. Wallet Integration: Add support for multiple wallet providers
2. Transaction Monitoring: Implement real-time transaction update notifications
3. API Documentation: Generate interactive API documentation
4. Performance Optimization: Improve the ability to handle a large number of requests

Contribution Guidelines

1. Fork the repository
2. Create a feature branch
3. Implement your changes
4. Submit a pull request

Important Notes

⚠️ Important Note

• Always use a "verified" blockchain in a production environment.
• Securely store wallet seeds and private keys.
• Monitor transaction fees.
• Conduct comprehensive testing on the testnet.

Resources

• XRPL Documentation
• MCP Protocol Documentation
• FastAPI Documentation

📄 License

MIT