xrpl mcp

by RomThpt
Verified
MIT License
3
  • Linux
  • Apple

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Used for environment variable management and configuration, allowing the server to securely store sensitive data like wallet seeds and network selection.

  • Serves as the runtime environment for the MCP server, with version 18.0.0 or higher required as a prerequisite.

  • Implementation language for the MCP server, providing type safety and modern language features.

Servidor de protocolo de contexto del modelo de libro mayor XRP

Licencia: MIT | Redes XRPL | TypeScript | xrpl.js

Un servidor integral de Protocolo de Contexto de Modelo (MCP) que proporciona servicios de blockchain para el ecosistema XRP Ledger. Este servidor permite a los agentes de IA interactuar con las redes principal, de prueba y de desarrollo de XRPL mediante una interfaz unificada.

📋 Contenido

🔭 Descripción general

El servidor MCP XRPL aprovecha el Protocolo de Contexto de Modelo para proporcionar servicios de contabilidad XRP a agentes de IA. Admite una amplia gama de servicios, entre ellos:

  • Lectura del estado del libro mayor (saldos, transacciones, información de cuentas, etc.)
  • Interactuar con contratos inteligentes (a través de Hooks)
  • Transferencia de XRP y tokens emitidos
  • Consulta de metadatos y saldos de tokens
  • Gestión de identificadores descentralizados (DID)
  • Trabajar con NFT en XRPL
  • Operaciones de creadores de mercado automatizados (AMM)
  • Canales de pago, fideicomisos y cheques
  • Operaciones de datos de Oracle
  • Gestión de líneas de confianza

Todos los servicios se exponen a través de una interfaz consistente de herramientas y recursos MCP, lo que facilita que los agentes de IA descubran y utilicen la funcionalidad XRPL.

✨ Características

Gestión de cuentas

  • Conectarse a redes XRPL (MainNet, TestNet, DevNet)
  • Recuperación de información de la cuenta
  • Gestión de propiedades de cuentas
  • Preautorización de depósito
  • Gestión regular de claves

Operaciones con XRP y tokens

  • Transferir XRP entre cuentas
  • Obtener metadatos del token (nombre, símbolo, decimales, suministro)
  • Consultar saldos de tokens
  • Transferir tokens entre direcciones
  • Aprobar el gasto de tokens
  • Recuperación de tokens

Operaciones NFT

  • Acuñar NFT en el libro mayor de XRP
  • Ver metadatos de NFT
  • Verificar la propiedad del NFT
  • Transferir NFT entre direcciones
  • Consigue colecciones de NFT

Identificador descentralizado (DID)

  • Crear DID en el XRPL
  • Resolver DID
  • Actualizar documentos DID
  • Desactivar DID

Operaciones de AMM

  • Crear creadores de mercado automatizados
  • Depósito a AMM
  • Realizar ofertas en AMM
  • Votación sobre los parámetros de AMM
  • Eliminar AMM
  • Recuperación de activos de los AMM

Verificar operaciones

  • Crear cheques
  • cobrar cheques
  • Cancelar cheques

Operaciones de oferta/DEX

  • Crear ofertas
  • Cancelar ofertas

Operaciones de Oracle

  • Establecer datos de Oracle
  • Eliminar datos de Oracle

Canales de pago

  • Crear canales de pago
  • Canales de pago de fondos
  • Reclamación de los canales de pago

Depósito

  • Crear fideicomisos
  • Finalizar los fideicomisos
  • Cancelar fideicomisos

Líneas de confianza

  • Establecer y administrar líneas de confianza

Venta de entradas

  • Crear tickets para el procesamiento de transacciones

🌐 Redes compatibles

  • MainNet : Red de producción de XRP Ledger
  • TestNet : Red de pruebas para el desarrollo
  • DevNet : Red de desarrollo para funciones experimentales

🛠️ Requisitos previos

  • Node.js 18.0.0 o superior

📦 Instalación

# 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

⚙️ Configuración del servidor

Cree un archivo .env en la raíz del proyecto con las siguientes 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

🚀 Uso

Iniciando el servidor

# Start the server in stdio mode (for CLI tools) npm start

Conectarse al servidor

Conéctese a este servidor MCP con cualquier cliente compatible con MCP. Para realizar pruebas y depurar, puede usar el Inspector de MCP.

Referencia de API

Herramientas

El servidor proporciona las siguientes herramientas MCP para los agentes:

Gestión de cuentas

Nombre de la herramientaDescripciónParámetros clave
connect-to-xrplConéctese a XRP Ledger usando una semillasemilla, red
get-account-infoObtener información de la cuentadirección, red
delete-accountEliminar una cuenta XRPLclave privada, destino, red
set-account-propertiesEstablecer propiedades de la cuentaclave privada, propiedades, red
deposit-preauthPreautorizar un depósitoclave privada, autorizar, red
set-regular-keyEstablecer una clave regular para una cuentaclave privada, clave regular, red

Operaciones con XRP y tokens

Nombre de la herramientaDescripciónParámetros clave
transfer-xrpEnviar XRP a una cuentaclave privada, a, cantidad, red
get-token-metadataObtener metadatos del tokendirección de token, red
check-token-balanceConsultar el saldo del tokendirección del token, dirección del propietario, red
transfer-tokenTokens de transferenciaclave privada, dirección del token, a, cantidad, red
approve-token-spendingAprobar el gasto de tokensclave privada, dirección de token, límite, red
token-clawbackFichas de recuperaciónclave privada, dirección del token, de, cantidad, red

Operaciones NFT

Nombre de la herramientaDescripciónParámetros clave
nft-mintAcuñar un NFTclave privada, uri, indicadores, red
get-nft-infoObtener metadatos de NFTtokenID, red
check-nft-ownershipVerificar la propiedad del NFTtokenID, dirección del propietario, red
transfer-nftTransferir un NFTclave privada, ID de token, a, red
get-nft-collectionConsigue NFT en una coleccióndirección, red

Operaciones DID

Nombre de la herramientaDescripciónParámetros clave
create-didCrear un DIDclave privada, datos, red
resolve-didResolver un DIDhizo, red
update-didActualizar un DIDclave privada, hizo, datos, red
deactivate-didDesactivar un DIDclave privada, hizo, red

Operaciones de AMM

Nombre de la herramientaDescripciónParámetros clave
amm-createCrear un AMMclave privada, activos, red
amm-depositDepositar en un AMMclave privada, ammID, activos, red
amm-bidRealizar una oferta en un AMMclave privada, ammID, oferta, red
amm-voteVotación sobre los parámetros de AMMclave privada, ammID, voto, red
amm-deleteEliminar un AMMclave privada, ammID, red
amm-clawbackRecuperación de activos de AMMclave privada, ammID, activos, red

Recursos

El servidor expone datos XRPL a través de las siguientes URI de recursos MCP:

Recursos del libro mayor

Patrón de URI de recursoDescripción
xrpl://{network}/ledger/currentInformación del libro mayor actual
xrpl://{network}/ledger/{ledger_index}Libro mayor por índice
xrpl://{network}/account/{address}Información de la cuenta
xrpl://{network}/account/{address}/balanceSaldo de la cuenta XRP
xrpl://{network}/tx/{tx_hash}Detalles de la transacción

Recursos de tokens

Patrón de URI de recursoDescripción
xrpl://{network}/token/{currency}/{issuer}Información del token
xrpl://{network}/token/{currency}/{issuer}/balanceOf/{address}Saldo de tokens
xrpl://{network}/nft/{tokenID}Información de NFT
xrpl://{network}/nft/{tokenID}/ownerInformación de propiedad de NFT

Consideraciones de seguridad

  • Las semillas de billetera se utilizan solo para la firma de transacciones y deben mantenerse seguras.
  • Considere implementar mecanismos de autenticación adicionales para el uso en producción
  • Para servicios de alto valor, considere agregar pasos de confirmación
  • Las operaciones predeterminadas se realizan en TestNet para garantizar la seguridad durante el desarrollo.
  • Utilice variables de entorno para una configuración sensible

📁 Estructura del proyecto

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

🛠️ Desarrollo

Agregar nuevas herramientas

Para agregar una nueva herramienta:

  1. Cree un nuevo archivo TypeScript en el directorio apropiado en src/transactions/
  2. Importar el servidor desde server/server.js
  3. Define la herramienta usando server.tool()
  4. Importar la herramienta en src/index.ts

Dependencias del proyecto

  • @modelcontextprotocol/sdk : SDK de MCP
  • xrpl : API de JavaScript/TypeScript para el libro mayor de XRP
  • dotenv : Gestión de variables de entorno
  • zod : Declaración y validación de esquemas basados en TypeScript

📄 Licencia

Este proyecto está licenciado bajo los términos de la Licencia MIT.

⚠️ Descargo de responsabilidad

Este software se proporciona únicamente con fines educativos y de desarrollo. Úselo bajo su propia responsabilidad. Realice siempre pruebas exhaustivas en la red de prueba antes de usarlo en la red principal con XRP real.

-
security - not tested
A
license - permissive license
-
quality - not tested

Servidor CP que proporciona integración con XRP Ledger. Este servidor permite a los asistentes de IA acceder a la información de la cuenta, el historial de transacciones y los datos de la red en XRP Ledger, con capacidades para consultar objetos del libro mayor, enviar transacciones y monitorear la red.

  1. 📋 Contents
    1. 🔭 Overview
      1. ✨ Features
        1. Account Management
        2. XRP and Token Operations
        3. NFT Operations
        4. Decentralized Identifier (DID)
        5. AMM Operations
        6. Check Operations
        7. Offer/DEX Operations
        8. Oracle Operations
        9. Payment Channels
        10. Escrow
        11. Trustlines
        12. Ticketing
      2. 🌐 Supported Networks
        1. 🛠️ Prerequisites
          1. 📦 Installation
            1. ⚙️ Server Configuration
              1. 🚀 Usage
                1. Starting the Server
                2. Connecting to the Server
              2. 📚 API Reference
                1. Tools
                2. Resources
              3. 🔒 Security Considerations
                1. 📁 Project Structure
                  1. 🛠️ Development
                    1. Adding New Tools
                    2. Project Dependencies
                  2. 📄 License
                    1. ⚠️ Disclaimer
                      ID: aifp64y484