Go Sui MCP

🚀 Go Sui MCP (管理控制平面)

Go Sui MCP是一个基于Go语言开发的区块链Sui管理控制平面服务器，通过提供REST API实现与本地Sui客户端命令的交互，为用户操作Sui客户端提供便利。

🚀 快速开始

在使用Go Sui MCP之前，需要确保满足以下先决条件：

• Go语言版本1.20及以上
• Sui客户端已安装并添加到PATH中

✨ 主要特性

• 提供RESTful API，支持Sui客户端操作。
• 具备命令行界面，方便进行服务器控制。
• 支持通过配置文件、环境变量或命令行标志进行灵活配置。

📦 安装指南

按照以下步骤进行安装：

# 克隆仓库
git clone https://github.com/krli/go-sui-mcp.git
cd go-sui-mcp

# 编译应用
go build -o go-sui-mcp

# 启动服务器
./go-sui-mcp server

💻 使用示例

基础用法

以下是一些常见操作的使用示例：

• 获取Sui客户端版本：

curl http://localhost:8080/api/sui/version

• 查询指定地址的余额：

curl http://localhost:8080/api/sui/balance/0x123456789abcdef

📚 详细文档

配置方式

支持以下三种配置方式：

1. 配置文件（默认路径：$HOME/.go-sui-mcp.yaml）
2. 环境变量
3. 命令行参数

示例配置文件：

server:
  port: 8080
  host: "0.0.0.0"
sui:
  executable_path: "sui"

环境变量设置：

GOSUI_SERVER_PORT=8080
GOSUI_SERVER_HOST=0.0.0.0
GOSUI_SUI_EXECUTABLE_PATH=sui

API接口

健康检查

GET /health

Sui客户端API

GET /api/sui/version                 # 获取Sui客户端版本信息
GET /api/sui/balance/:address        # 查询指定地址的余额
GET /api/sui/objects/:address        # 获取指定地址的所有对象
GET /api/sui/validators              # 获取活动验证节点列表
GET /api/sui/network                 # 获取网络信息
GET /api/sui/transaction/:txid       # 获取交易详情
POST /api/sui/transfer               # 发送SUI代币

POST /api/sui/transfer

请求体示例：

{
  "recipient": "0x123456789abcdef",
  "amount": "1000000000",
  "gas_budget": "10000"
}

📄 许可证

见LICENSE文件。