XRP Ledger Model Context Protocol Server

1# XRP Ledger Model Context Protocol Server
2 
3[![MCP Server](https://glama.ai/mcp/servers/%40RomThpt/mcp-xrpl/badge)](https://glama.ai/mcp/servers/%40RomThpt/mcp-xrpl)
4 
5License: MIT | XRPL Networks | TypeScript | xrpl.js
6 
7A comprehensive Model Context Protocol (MCP) server that provides blockchain services for the XRP Ledger ecosystem. This server enables AI agents to interact with XRPL MainNet, TestNet, and DevNet with a unified interface.
8 
9## 📋 Contents
10 
11-   [Overview](#-overview)
12-   [Features](#-features)
13-   [Supported Networks](#-supported-networks)
14-   [Prerequisites](#️-prerequisites)
15-   [Installation](#-installation)
16-   [Server Configuration](#️-server-configuration)
17-   [Usage](#-usage)
18-   [API Reference](#-api-reference)
19-   [Security Considerations](#-security-considerations)
20-   [Project Structure](#-project-structure)
21-   [Development](#️-development)
22-   [License](#-license)
23 
24## 🔭 Overview
25 
26The MCP XRPL Server leverages the Model Context Protocol to provide XRP Ledger services to AI agents. It supports a wide range of services including:
27 
28-   Reading ledger state (balances, transactions, account info, etc.)
29-   Interacting with smart contracts (via Hooks)
30-   Transferring XRP and issued tokens
31-   Querying token metadata and balances
32-   Managing decentralized identifiers (DIDs)
33-   Working with NFTs on the XRPL
34-   Automated Market Maker (AMM) operations
35-   Payment channels, escrows, and checks
36-   Oracle data operations
37-   Trustline management
38 
39All services are exposed through a consistent interface of MCP tools and resources, making it easy for AI agents to discover and use XRPL functionality.
40 
41## ✨ Features
42 
43### Account Management
44 
45-   Connect to XRPL networks (MainNet, TestNet, DevNet)
46-   Account information retrieval
47-   Account property management
48-   Deposit preauthorization
49-   Regular key management
50 
51### XRP and Token Operations
52 
53-   Transfer XRP between accounts
54-   Get token metadata (name, symbol, decimals, supply)
55-   Check token balances
56-   Transfer tokens between addresses
57-   Approve token spending
58-   Token clawback
59 
60### NFT Operations
61 
62-   Mint NFTs on the XRP Ledger
63-   View NFT metadata
64-   Verify NFT ownership
65-   Transfer NFTs between addresses
66-   Get NFT collections
67 
68### Decentralized Identifier (DID)
69 
70-   Create DIDs on the XRPL
71-   Resolve DIDs
72-   Update DID documents
73-   Deactivate DIDs
74 
75### AMM Operations
76 
77-   Create Automated Market Makers
78-   Deposit to AMMs
79-   Place bids on AMMs
80-   Vote on AMM parameters
81-   Delete AMMs
82-   Clawback assets from AMMs
83 
84### Check Operations
85 
86-   Create checks
87-   Cash checks
88-   Cancel checks
89 
90### Offer/DEX Operations
91 
92-   Create offers
93-   Cancel offers
94 
95### Oracle Operations
96 
97-   Set oracle data
98-   Delete oracle data
99 
100### Payment Channels
101 
102-   Create payment channels
103-   Fund payment channels
104-   Claim from payment channels
105 
106### Escrow
107 
108-   Create escrows
109-   Finish escrows
110-   Cancel escrows
111 
112### Trustlines
113 
114-   Set and manage trustlines
115 
116### Ticketing
117 
118-   Create tickets for transaction processing
119 
120## 🌐 Supported Networks
121 
122-   **MainNet**: Production XRP Ledger network
123-   **TestNet**: Test network for development
124-   **DevNet**: Development network for experimental features
125 
126## 🛠️ Prerequisites
127 
128-   Node.js 18.0.0 or higher
129 
130## 📦 Installation
131 
132```bash
133# Clone the repository
134git clone https://github.com/yourusername/mcp-xrpl.git
135cd mcp-xrpl
136 
137# Install dependencies
138npm install
139 
140# Build the project
141npm run build
142```
143 
144## ⚙️ Server Configuration
145 
146Create a `.env` file in the project root with the following variables:
147 
148```
149# Optional: XRPL wallet seed for automatic connection
150# If not provided, you can connect using the connect-to-xrpl tool
151DEFAULT_SEED=sEdVoKkRRF8RsNYZ689NDeMyrijiCbg  # Example - replace with your own or remove
152 
153# Network selection (default is "testnet")
154XRPL_NETWORK=testnet  # Options: mainnet, testnet, devnet
155```
156 
157## 🚀 Usage
158 
159### Starting the Server
160 
161```bash
162# Start the server in stdio mode (for CLI tools)
163npm start
164```
165 
166### Connecting to the Server
167 
168Connect to this MCP server using any MCP-compatible client. For testing and debugging, you can use the MCP Inspector.
169 
170## 📚 API Reference
171 
172### Tools
173 
174The server provides the following MCP tools for agents:
175 
176#### Account Management
177 
178| Tool Name                | Description                        | Key Parameters                   |
179| ------------------------ | ---------------------------------- | -------------------------------- |
180| `connect-to-xrpl`        | Connect to XRP Ledger using a seed | seed, network                    |
181| `get-account-info`       | Get account information            | address, network                 |
182| `delete-account`         | Delete an XRPL account             | privateKey, destination, network |
183| `set-account-properties` | Set account properties             | privateKey, properties, network  |
184| `deposit-preauth`        | Preauthorize a deposit             | privateKey, authorize, network   |
185| `set-regular-key`        | Set a regular key for an account   | privateKey, regularKey, network  |
186 
187#### XRP and Token Operations
188 
189| Tool Name                | Description            | Key Parameters                                  |
190| ------------------------ | ---------------------- | ----------------------------------------------- |
191| `transfer-xrp`           | Send XRP to an account | privateKey, to, amount, network                 |
192| `get-token-metadata`     | Get token metadata     | tokenAddress, network                           |
193| `check-token-balance`    | Check token balance    | tokenAddress, ownerAddress, network             |
194| `transfer-token`         | Transfer tokens        | privateKey, tokenAddress, to, amount, network   |
195| `approve-token-spending` | Approve token spending | privateKey, tokenAddress, limit, network        |
196| `token-clawback`         | Clawback tokens        | privateKey, tokenAddress, from, amount, network |
197 
198#### NFT Operations
199 
200| Tool Name             | Description              | Key Parameters                   |
201| --------------------- | ------------------------ | -------------------------------- |
202| `nft-mint`            | Mint an NFT              | privateKey, uri, flags, network  |
203| `get-nft-info`        | Get NFT metadata         | tokenID, network                 |
204| `check-nft-ownership` | Verify NFT ownership     | tokenID, ownerAddress, network   |
205| `transfer-nft`        | Transfer an NFT          | privateKey, tokenID, to, network |
206| `get-nft-collection`  | Get NFTs in a collection | address, network                 |
207 
208#### DID Operations
209 
210| Tool Name        | Description      | Key Parameters                 |
211| ---------------- | ---------------- | ------------------------------ |
212| `create-did`     | Create a DID     | privateKey, data, network      |
213| `resolve-did`    | Resolve a DID    | did, network                   |
214| `update-did`     | Update a DID     | privateKey, did, data, network |
215| `deactivate-did` | Deactivate a DID | privateKey, did, network       |
216 
217#### AMM Operations
218 
219| Tool Name      | Description              | Key Parameters                     |
220| -------------- | ------------------------ | ---------------------------------- |
221| `amm-create`   | Create an AMM            | privateKey, assets, network        |
222| `amm-deposit`  | Deposit to an AMM        | privateKey, ammID, assets, network |
223| `amm-bid`      | Place bid on an AMM      | privateKey, ammID, bid, network    |
224| `amm-vote`     | Vote on AMM parameters   | privateKey, ammID, vote, network   |
225| `amm-delete`   | Delete an AMM            | privateKey, ammID, network         |
226| `amm-clawback` | Clawback assets from AMM | privateKey, ammID, assets, network |
227 
228### Resources
229 
230The server exposes XRPL data through the following MCP resource URIs:
231 
232#### Ledger Resources
233 
234| Resource URI Pattern                         | Description                |
235| -------------------------------------------- | -------------------------- |
236| `xrpl://{network}/ledger/current`            | Current ledger information |
237| `xrpl://{network}/ledger/{ledger_index}`     | Ledger by index            |
238| `xrpl://{network}/account/{address}`         | Account information        |
239| `xrpl://{network}/account/{address}/balance` | Account XRP balance        |
240| `xrpl://{network}/tx/{tx_hash}`              | Transaction details        |
241 
242#### Token Resources
243 
244| Resource URI Pattern                                             | Description               |
245| ---------------------------------------------------------------- | ------------------------- |
246| `xrpl://{network}/token/{currency}/{issuer}`                     | Token information         |
247| `xrpl://{network}/token/{currency}/{issuer}/balanceOf/{address}` | Token balance             |
248| `xrpl://{network}/nft/{tokenID}`                                 | NFT information           |
249| `xrpl://{network}/nft/{tokenID}/owner`                           | NFT ownership information |
250 
251## 🔒 Security Considerations
252 
253-   Wallet seeds are used only for transaction signing and should be kept secure
254-   Consider implementing additional authentication mechanisms for production use
255-   For high-value services, consider adding confirmation steps
256-   Default operations are performed on TestNet to ensure safety during development
257-   Use environment variables for sensitive configuration
258 
259## 📁 Project Structure
260 
261```
262mcp-xrpl/
263├── src/
264│   ├── core/                # Core utilities and services
265│   │   ├── constants.ts     # XRPL network URLs and other constants
266│   │   ├── state.ts         # State management for connected wallet
267│   │   ├── utils.ts         # Helper functions
268│   │   └── services/        # Service modules
269│   ├── server/              # MCP server implementation
270│   ├── transactions/        # XRPL transaction implementation
271│   │   ├── token/           # Token-related transactions
272│   │   ├── nft/             # NFT-related transactions
273│   │   ├── did/             # DID-related transactions
274│   │   ├── amm/             # AMM-related transactions
275│   │   ├── check/           # Check-related transactions
276│   │   ├── offer/           # Offer-related transactions
277│   │   ├── oracle/          # Oracle-related transactions
278│   │   ├── payment/         # Payment-related transactions
279│   │   ├── escrow/          # Escrow-related transactions
280│   │   └── trust/           # Trust line-related transactions
281│   └── index.ts             # Entry point
282├── build/                   # Compiled JavaScript output
283├── package.json
284├── package-lock.json
285└── tsconfig.json
286```
287 
288## 🛠️ Development
289 
290### Adding New Tools
291 
292To add a new tool:
293 
2941. Create a new TypeScript file in the appropriate directory under `src/transactions/`
2952. Import the server from `server/server.js`
2963. Define the tool using `server.tool()`
2974. Import the tool in `src/index.ts`
298 
299### Project Dependencies
300 
301-   [`@modelcontextprotocol/sdk`](https://www.npmjs.com/package/@modelcontextprotocol/sdk): MCP SDK
302-   [`xrpl`](https://www.npmjs.com/package/xrpl): XRP Ledger JavaScript/TypeScript API
303-   [`dotenv`](https://www.npmjs.com/package/dotenv): Environment variable management
304-   [`zod`](https://www.npmjs.com/package/zod): TypeScript-first schema declaration and validation
305 
306## 📄 License
307 
308This project is licensed under the terms of the MIT License.
309 
310## ⚠️ Disclaimer
311 
312This software is provided for educational and development purposes only. Use it at your own risk. Always test thoroughly on the Testnet before using on Mainnet with real XRP.
313