Go Sui MCP

🚀 Go Sui MCP (Management Control Plane)

A management control plane server for the Sui blockchain, written in Go, which provides REST APIs to interact with the local Sui client commands.

🚀 Quick Start

Go Sui MCP is a server that offers RESTful APIs to interact with the Sui client. It allows users to manage and control Sui - related operations through a simple and efficient interface.

✨ Features

• RESTful APIs support Sui client operations.
• A command - line interface is available for server control.
• Configuration can be done via configuration files, environment variables, or command - line flags.

📦 Installation

Prerequisites

• Go version 1.20 or higher.
• The Sui client should be installed and added to the PATH.

Steps

# Clone the repository
git clone https://github.com/krli/go-sui-mcp.git
cd go-sui-mcp

# Compile the application
go build -o go-sui-mcp

# Start the server
./go-sui-mcp server

Configuration

The server supports the following three configuration methods:

1. Configuration file (default path: $HOME/.go-sui-mcp.yaml)
2. Environment variables
3. Command - line arguments

Example Configuration File

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

Environment Variables

GOSUI_SERVER_PORT=8080
GOSUI_SERVER_HOST=0.0.0.0
GOSUI_SUI_EXECUTABLE_PATH=sui

📚 Documentation

API Interfaces

Health Check

GET /health

Sui Client API

GET /api/sui/version                 # Get the version information of the Sui client
GET /api/sui/balance/:address        # Query the balance of the specified address
GET /api/sui/objects/:address        # Get all objects of the specified address
GET /api/sui/validators              # Get the list of active validator nodes
GET /api/sui/network                 # Get network information
GET /api/sui/transaction/:txid       # Get transaction details
POST /api/sui/transfer               # Transfer SUI tokens

POST /api/sui/transfer

Request Body Example:

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

💻 Usage Examples

Basic Usage

Get the Sui Client Version

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

Query the Balance of a Specified Address

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

📄 License

See the LICENSE file.