Xrpl MCP Server

🚀 XRPL MCP Server

An MCP (Model Context Protocol) server that provides access to XRP Ledger data and functionality for AI models.

🚀 Quick Start

The XRPL MCP Server acts as a bridge between large language models (such as Claude and GPT) and the XRP Ledger. It enables AI models to retrieve account information from the XRP Ledger through a standardized API interface.

✨ Features

• Retrieve account information (balance, sequence number)
• Query trust lines and issued currencies
• View NFTs owned by an account
• Retrieve transaction history
• Access order book data from the DEX
• Submit signed transactions to the network
• Get server status information
• Reliably access XRP Ledger data via MCP
• Facilitate integration with MCP-compatible AI applications

📦 Installation

From Source Code

1. Clone this repository:

   git clone https://github.com/lgcarrier/xrpl-mcp-server.git
   cd xrpl-mcp-server
   

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

3. Install dependencies:

   pip install -r requirements.txt
   

Using pip

pip install xrpl-mcp-server

📚 Documentation

The server uses the following environment variables:

• XRPL_NODE_URL - The URL of the XRP Ledger node (default is https://xrpl.xrpspaces.com)

💻 Usage Examples

Run from Source Code

1. Start the MCP agent:

   python -m xrpl_mcp_agent
   

2. Configure the MCP client in Claude using the proxy address:

from xrpl_mcp_client import McpClient

client = McpClient("http://localhost:5000")

Run as an Installed Package

1. Start the MCP agent:

   xrpl-mcp-agent
   

2. Configure the MCP client in Claude using the proxy address:

from xrpl_mcp_client import McpClient

client = McpClient("http://localhost:5000")

Basic Usage

Ask Claude:

What is the XRP balance of account rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe?

Claude can use the get_account_info tool to directly obtain this information from the XRP Ledger.

Example response:

Account: rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe
XRP Balance: 25.5
Sequence Number: 123456

Advanced Usage

Another example:

Which NFTs does account rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe own?

Claude can use the get_account_nfts tool to retrieve this information.

🔧 Technical Details

Refer to the documentation in the memory-bank directory for detailed information about the architecture, coding rules, and implementation plan.

Set up the development environment:

pip install -e ".[dev]"

📄 License

This project is licensed under the MIT License.