使用说明内容(Markdown格式)
-
项目简介
- 该项目实现了一个基于 MCP 理念的后端服务端(服务器端)的实现,用于向 LLM 客户端提供资源管理、工具注册与执行、以及提示模板的渲染等功能,核心通过 JSON-RPC 与客户端进行通信,便于将 AI 决策与区块链交易执行对接。
-
主要功能点
- MCP风格的工具注册与执行:服务器端注册多达20+个工具,LLM 客户端可以通过调用工具接口执行具体操作(如钱包管理、余额查询、交易执行、数据存储等)。
- 资源与数据访问:提供资源管理能力,支持对 Walrus 存储、交易记录、市场数据等进行读写和查询。
- 交易与合约交互:通过 Sui Move 合约环境,执行交易签名、DEX 互动、以及对 Season Manager 等合约的调用。
- 安全与会话管理:服务端包含会话与授权机制,确保操作的可审计性与权限控制。
- 多传输协议接入:当前实现以标准输入输出(stdio)传输进行测试,后续可扩展为 SSE、WebSocket 等。
-
安装步骤
- 依赖与构建
- 需要 Node.js 以及 npm/yarn,用于构建和运行 sui-mcp 相关模块。
- 构建与运行
- 运行环境示例(需根据实际项目结构调整路径):
- 先安装依赖并构建 sui-mcp 模块,
- 再启动服务器(示例为本地测试环境通过 stdio 传输启动,需要在服务器启动点执行构建后的输出)。
- 运行环境示例(需根据实际项目结构调整路径):
- 测试方法
- 使用本地 MCP 客户端测试时,需确保:
- SUI_PRIVATE_KEY 能正确提供(环境变量或 .env 配置)
- 本地契约、全局对象等地址信息正确配置
- 使用本地 MCP 客户端测试时,需确保:
- 服务器启动命令(示例)
- 命令: node
- 参数: [ "sui-mcp/dist/index.js" ]
- 说明: 这是仓库中 MCP 服务器的启动入口,测试场景使用 stdio 传输来与 MCP 客户端进行通信。
- 依赖与构建
-
服务器配置(给 MCP 客户端的配置示例,json 格式,包含 server name、command、args 等)
- 示例(请在实际使用中按需修改路径与名称): { "server_name": "trade-arena-mcp", "command": "node", "args": ["sui-mcp/dist/index.js"], "working_directory": "<你的项目根目录>", "notes": "启动前请确保 SUI_PRIVATE_KEY 已正确配置环境变量(用于签名与账户管理)。服务器端将通过 stdio 与 MCP 客户端通信。" }
-
基本使用方法
- 启动前准备
- 确认 Node.js、npm 安装完毕
- 设置 SUI_PRIVATE_KEY 等所需环境变量
- 启动与连接
- 构建并启动 sui-mcp 服务器入口
- 使用 MCP 客户端连接本服务器,调用注册的工具与资源接口
- 运行与测试
- 通过本地测试,逐步调用如“GetAllTokenBalancesTool”、“tradeArenaAiExecuteLongTool”等工具,验证返回格式与错误处理
- 观察日志输出,确保没有未捕获的异常
- 安全与运维
- 生产环境应将私钥托管在安全环境,并对工具执行进行权限控制与审计
- 启动前准备
信息
分类
AI与计算