MCP Xrpl

🚀 MCP-XRPL Project Guide

MCP-XRPL is a protocol adapter based on the Model Context Protocol (MCP), supporting the XRP Ledger ecosystem. It provides a bridge for MCP, enabling developers to easily interact with the XRPL network.

🚀 Quick Start

📦 Installation

Install Dependencies

npm install @modelcontextprotocol/sdk xrpl dotenv zod

Clone the Repository

git clone git@github.com:yourusername/mcp-xrpl.git
cd mcp-xrpl

Configure Environment Variables

Create a .env file and add the following content:

WALLET_SEED=your_wallet_seed_here
DEFAULT_NETWORK=testnet # Optional, default is testnet
MCP_ENDPOINT=http://localhost:3000 # Optional, custom MCP service address

Start the Project

npm run dev

📚 Documentation

Configuration File Explanation

Network Configuration

• DEFAULT_NETWORK: Set the default network (mainnet or testnet), default is testnet.
• MCP_ENDPOINT: Customize the MCP service address for resource URI generation.

Security Precautions

• Do not directly use the wallet seed in the production environment.
• It is recommended to verify functions in the test environment.
• Use HTTPS to ensure communication security.

✨ Features

Supported XRPL Resources

Account Information

• Get account balance: xrpl://{network}/account/{address}
• Get XRP balance: xrpl://{network}/account/{address}/balance

Transaction Records

• Query transaction details: xrpl://{network}/tx/{tx_hash}

Token Information

• Get token details: xrpl://{network}/token/{currency}/{issuer}
• Query token balance: xrpl://{network}/token/{currency}/{issuer}/balanceOf/{address}

NFT Information

• View NFT details: xrpl://{network}/nft/{tokenID}
• Get owner information: xrpl://{network}/nft/{tokenID}/owner

💻 Usage Examples

Development Guide

Add a New Feature Module

1. Create a new TypeScript file in the src/transactions/ directory.
2. Import the server instance: import { server } from '../server/server.js'.
3. Define a new tool: server.tool(), and import it in src/index.ts.

Code Structure

mcp-xrpl/
├── src/
│   ├── core/                # Core tools and services
│   ├── transactions/       # Various transaction processing logics
│   └── server/             # MCP adapter server side
└── package.json            # Project dependency management file

🔧 Technical Details

Security Precautions

• Use environment variables to manage sensitive configurations.
• It is recommended to enable authentication in the production environment.
• Ensure that network communication uses HTTPS.

🤝 Project Contribution

Welcome contributions from the community! Please follow the standard Git workflow:

1. Create a feature branch: git checkout -b feature/new-feature.
2. Commit code changes: git add .; git commit -m "Add new feature".
3. Push to the remote repository: git push origin feature/new-feature.
4. Create a Pull Request.

📃 Contributors List

• Alice Smith - Project Lead
• Bob Johnson - Core Developer
• Charlie Brown - Test Engineer

📄 License

MCP-XRPL is licensed under the MIT license. Please refer to the LICENSE file for details.

Thank you for your attention and support for MCP-XRPL! If you need further assistance, please contact the project maintenance team at any time.