A 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.
License: MIT | XRPL Networks | TypeScript | xrpl.js
A 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.
The MCP XRPL Server leverages the Model Context Protocol to provide XRP Ledger services to AI agents. It supports a wide range of services including:
All services are exposed through a consistent interface of MCP tools and resources, making it easy for AI agents to discover and use XRPL functionality.
# Clone the repository
git clone https://github.com/yourusername/mcp-xrpl.git
cd mcp-xrpl
# Install dependencies
npm install
# Build the project
npm run build
Create a .env file in the project root with the following variables:
# Optional: XRPL wallet seed for automatic connection
# If not provided, you can connect using the connect-to-xrpl tool
DEFAULT_SEED=sEdVoKkRRF8RsNYZ689NDeMyrijiCbg # Example - replace with your own or remove
# Network selection (default is "testnet")
XRPL_NETWORK=testnet # Options: mainnet, testnet, devnet
# Start the server in stdio mode (for CLI tools)
npm start
Connect to this MCP server using any MCP-compatible client. For testing and debugging, you can use the MCP Inspector.
The server provides the following MCP tools for agents:
| Tool Name | Description | Key Parameters |
|---|---|---|
connect-to-xrpl | Connect to XRP Ledger using a seed | seed, network |
get-account-info | Get account information | address, network |
delete-account | Delete an XRPL account | privateKey, destination, network |
set-account-properties | Set account properties | privateKey, properties, network |
deposit-preauth | Preauthorize a deposit | privateKey, authorize, network |
set-regular-key | Set a regular key for an account | privateKey, regularKey, network |
| Tool Name | Description | Key Parameters |
|---|---|---|
transfer-xrp | Send XRP to an account | privateKey, to, amount, network |
get-token-metadata | Get token metadata | tokenAddress, network |
check-token-balance | Check token balance | tokenAddress, ownerAddress, network |
transfer-token | Transfer tokens | privateKey, tokenAddress, to, amount, network |
approve-token-spending | Approve token spending | privateKey, tokenAddress, limit, network |
token-clawback | Clawback tokens | privateKey, tokenAddress, from, amount, network |
| Tool Name | Description | Key Parameters |
|---|---|---|
nft-mint | Mint an NFT | privateKey, uri, flags, network |
get-nft-info | Get NFT metadata | tokenID, network |
check-nft-ownership | Verify NFT ownership | tokenID, ownerAddress, network |
transfer-nft | Transfer an NFT | privateKey, tokenID, to, network |
get-nft-collection | Get NFTs in a collection | address, network |
| Tool Name | Description | Key Parameters |
|---|---|---|
create-did | Create a DID | privateKey, data, network |
resolve-did | Resolve a DID | did, network |
update-did | Update a DID | privateKey, did, data, network |
deactivate-did | Deactivate a DID | privateKey, did, network |
| Tool Name | Description | Key Parameters |
|---|---|---|
amm-create | Create an AMM | privateKey, assets, network |
amm-deposit | Deposit to an AMM | privateKey, ammID, assets, network |
amm-bid | Place bid on an AMM | privateKey, ammID, bid, network |
amm-vote | Vote on AMM parameters | privateKey, ammID, vote, network |
amm-delete | Delete an AMM | privateKey, ammID, network |
amm-clawback | Clawback assets from AMM | privateKey, ammID, assets, network |
The server exposes XRPL data through the following MCP resource URIs:
| Resource URI Pattern | Description |
|---|---|
xrpl://{network}/ledger/current | Current ledger information |
xrpl://{network}/ledger/{ledger_index} | Ledger by index |
xrpl://{network}/account/{address} | Account information |
xrpl://{network}/account/{address}/balance | Account XRP balance |
xrpl://{network}/tx/{tx_hash} | Transaction details |
| Resource URI Pattern | Description |
|---|---|
xrpl://{network}/token/{currency}/{issuer} | Token information |
xrpl://{network}/token/{currency}/{issuer}/balanceOf/{address} | Token balance |
xrpl://{network}/nft/{tokenID} | NFT information |
xrpl://{network}/nft/{tokenID}/owner | NFT ownership information |
mcp-xrpl/
├── src/
│ ├── core/ # Core utilities and services
│ │ ├── constants.ts # XRPL network URLs and other constants
│ │ ├── state.ts # State management for connected wallet
│ │ ├── utils.ts # Helper functions
│ │ └── services/ # Service modules
│ ├── server/ # MCP server implementation
│ ├── transactions/ # XRPL transaction implementation
│ │ ├── token/ # Token-related transactions
│ │ ├── nft/ # NFT-related transactions
│ │ ├── did/ # DID-related transactions
│ │ ├── amm/ # AMM-related transactions
│ │ ├── check/ # Check-related transactions
│ │ ├── offer/ # Offer-related transactions
│ │ ├── oracle/ # Oracle-related transactions
│ │ ├── payment/ # Payment-related transactions
│ │ ├── escrow/ # Escrow-related transactions
│ │ └── trust/ # Trust line-related transactions
│ └── index.ts # Entry point
├── build/ # Compiled JavaScript output
├── package.json
├── package-lock.json
└── tsconfig.json
To add a new tool:
src/transactions/server/server.jsserver.tool()src/index.ts@modelcontextprotocol/sdk: MCP SDKxrpl: XRP Ledger JavaScript/TypeScript APIdotenv: Environment variable managementzod: TypeScript-first schema declaration and validationThis project is licensed under the terms of the MIT License.
This 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.