README
🚀 XRPL MCP 服务器
XRPL MCP 服务器是一个基于模型上下文协议 (MCP) 的服务器,它为 AI 模型提供了访问 XRP 账本数据和功能的途径,有效搭建起 AI 与 XRP 账本之间的沟通桥梁。
🚀 快速开始
XRPL MCP 服务器是大型语言模型(如 Claude 和 GPT)与 XRP 账本之间的桥梁,借助标准化 API 接口,AI 模型能够从 XRP 账本检索账户信息。
✨ 主要特性
- 获取账户信息(余额、序列号)
- 查询信任线和发行的货币
- 查看账户拥有的 NFT
- 检索交易历史
- 访问 DEX 的订单簿数据
- 提交签名事务到网络
- 获取服务器状态信息
- 通过 MCP 可靠访问 XRP 账本数据
- 方便与 MCP 兼容的 AI 应用程序集成
📦 安装指南
从源代码安装
- 克隆此仓库:
git clone https://github.com/lgcarrier/xrpl-mcp-server.git cd xrpl-mcp-server - 创建并激活虚拟环境:
python -m venv venv source venv/bin/activate # 在 Windows 上:venv\Scripts\activate - 安装依赖项:
pip install -r requirements.txt
使用 pip 安装
pip install xrpl-mcp-server
📚 详细文档
配置
服务器使用以下环境变量:
XRPL_NODE_URL- XRP 账本节点的 URL(默认为https://xrpl.xrpspaces.com)
使用方法
从源代码运行
- 启动 MCP 代理:
python -m xrpl_mcp_agent - 在 Claude 中配置 MCP 客户端,使用代理地址:
from xrpl_mcp_client import McpClient
client = McpClient("http://localhost:5000")
作为已安装包运行
- 启动 MCP 代理:
xrpl-mcp-agent - 在 Claude 中配置 MCP 客户端,使用代理地址:
from xrpl_mcp_client import McpClient
client = McpClient("http://localhost:5000")
💻 使用示例
基础用法
询问 Claude:
请问账户
rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe的 XRP 平衡是多少?
Claude 可以使用 get_account_info 工具直接从 XRP 账本获取此信息。
示例响应:
账户:rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe
XRP 余额:25.5
序列号:123456
高级用法
询问:
账户
rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe拥有哪些 NFT?
Claude 可以使用 get_account_nfts 工具来检索此信息。
🔧 技术细节
参见 memory-bank 目录下的文档,了解有关架构、编码规则和实现计划的详细信息。
设置开发环境:
pip install -e ".[dev]"
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group