@jordangens/sui-mcp

0.0.5 • Public • Published

SuiMCP

An MCP server for the Sui network which can access data on the Sui network, and interface with your local Sui CLI.

Usage

To get started, run the following init command to setup SuiMCP:

npx @jordangens/sui-mcp@latest init

This will setup the Wallet that you'll use to interact with the chain. You can then configure your client with the following MCP configuration:

{
  "mcpServers": {
    "suiMcp": {
      "command": "npx",
      "args": ["@jordangens/sui-mcp@latest", "start"]
    }
  }
}

Here's the MCP documentation for popular clients:

Building Move

To build Move packages, you'll to have the Sui CLI installed and setup before you can use SuiMCP. You can follow the directions here: Sui CLI.

Features

Tools

  • get_default_address - Get the default wallet address
  • list_addresses - List all addresses available for the current wallet
  • set_default_address - Set the default address of the wallet
  • get_balance - Get the balance of a specific coin type for a wallet
  • get_all_balances - Get all balances for a wallet
  • get_owned_coin_objects - Get coin objects owned by a wallet, by coin type
  • get_object - Get an object by its ID
  • get_owned_objects - Get objects owned by a wallet
  • get_transaction - Get a transaction by its ID
  • build_move_package - Build a Sui Move package to bytecode
  • test_move_package - Test a Sui Move package
  • publish_move_package - Publish a Sui Move package to the Sui blockchain. This tool will also run Move build and Move test.

Readme

Keywords

none

Package Sidebar

Install

npm i @jordangens/sui-mcp

Weekly Downloads

18

Version

0.0.5

License

none

Unpacked Size

73.7 kB

Total Files

92

Last publish

Collaborators

  • jordangens