What is Xrpl Mcp Service

xrpl-mcp-service is an implementation of a Model Context Protocol (MCP) server that facilitates interaction with the XRP Ledger blockchain, providing standardized endpoints for AI models to access XRPL data and functionalities.

Use cases

Use cases for xrpl-mcp-service include querying account balances, managing trust lines, executing NFT transactions, viewing market prices, and submitting signed transactions to the XRP Ledger.

How to use

To use xrpl-mcp-service, create a .env file with the XRPL_NODE_URL, install the required dependencies using pip, and run the server with uvicorn. You can then make API calls to access various XRPL features.

Key features

Key features of xrpl-mcp-service include account information retrieval, decentralized exchange functionalities, NFT operations, trust line management, payment processing, and system status checks.

Where to use

xrpl-mcp-service can be utilized in financial applications, blockchain-based platforms, NFT marketplaces, and any system requiring interaction with the XRP Ledger for transactions and data retrieval.

XRPL MCP Service

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

Features

Account Information

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

Decentralized Exchange

• xrpl_order_book - View order book for currency pairs
• xrpl_market_price - Get current market prices
• xrpl_amm_info - Automated Market Maker information

NFT Operations

• xrpl_nft_offers - View NFT buy/sell offers

Trust Lines & Payments

• xrpl_set_trust_line - Establish new trust lines
• xrpl_remove_trust_line - Remove existing trust lines
• xrpl_payment_channels - Payment channel information
• xrpl_find_path - Payment path finding
• xrpl_deposit_auth - Check payment authorization

System

• xrpl_server_info - Node status and information
• xrpl_submit_tx - Submit signed transactions

Setup

1. Create a .env file:

XRPL_NODE_URL=https://xrplcluster.com

2. Install dependencies:

pip install xrpl-py fastapi uvicorn python-dotenv

3. Run the server:

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

API Usage Examples

Get Account Info

Get Account Balances

Set Trust Line

Get AMM Info

Get Market Price

Project Structure

├── main.py              # FastAPI application entry point
├── tools/
│   ├── __init__.py
│   ├── register_tools.py # Tool registration
│   └── xrpl_tools.py    # XRPL endpoint implementations

Key Components

1. xrpl_tools.py

   • Core XRPL interaction functions
   • Async implementation with event loop handling
   • Error handling and response formatting

2. register_tools.py

   • MCP tool registration
   • Endpoint mapping and configuration

Future Enhancements

1. AMM (Liquidity Pool) Operations

   • Create pools
   • Add/remove liquidity
   • Vote on pool parameters

2. Advanced Trading

   • Create/cancel offers
   • Automated trading functions
   • Price alerts

3. NFT Operations

   • Mint NFTs
   • Create/accept offers
   • Collection management

Common Issues

1. Async Event Loop: If you see “asyncio.run() cannot be called from a running event loop”, check the async implementation in xrpl_tools.py

2. Rate Limiting: Consider implementing rate limiting for production use

Contributing

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

Important Notes

• Always use “validated” ledger for production
• Secure wallet seeds and private keys
• Monitor transaction fees
• Test thoroughly on testnet first

Resources

• XRPL Documentation
• MCP Protocol Docs
• FastAPI Documentation

License

MIT