MCP Sui Tools
# Sui MCP Tools
This is a MCP (Model Context Protocol) toolkit based on the Sui blockchain. The project provides functionality to interact with the Sui blockchain and integrates the MCP SDK to implement model context protocol features.
## 🚀 Features
- Developed with TypeScript for type safety
- Deep integration with Sui blockchain functionality
- Support for multiple network environments (testnet, devnet)
- Complete build scripts and development toolchain
## 📦 Installation & Configuration
There are two ways to install and configure Sui MCP Tools:
### Method 1: Using npx (Recommended)
This is the simplest way - just add the following configuration to your Claude Desktop config file:
```json
{
"mcpServers": {
"sui-tools": {
"command": "npx",
"args": ["-y", "sui-mcp@latest"]
}
}
}
```
### Method 2: Local Build
1. Clone and install dependencies:
```bash
git clone https://github.com/0xdwong/sui-mcp.git
cd sui-mcp
yarn install
```
2. Build the project:
```bash
yarn build
```
3. Configure Claude Desktop with your local build:
```json
{
"mcpServers": {
"sui-tools": {
"command": "node",
"args": ["<absolute-path-to-your-project>/build/index.js"]
}
}
}
```
### Configuration Location
The Claude Desktop configuration file is located at:
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
- Linux: `~/.config/Claude/claude_desktop_config.json`
You can access this file via Claude Desktop: Claude > Settings > Developer > Edit Config
Restart Claude Desktop for the changes to take effect.
## 🛠Available Tools
- Testnet Faucet
> eg: request SUI for 0x9eb94b1c301505d188f1b97914208b31a5419b57b2a3571169ad2165d41c2ffa
- Check SUI balance
> eg: check SUI balance for 0x9eb94b1c301505d188f1b97914208b31a5419b57b2a3571169ad2165d41c2ffa
- Transfer SUI
> eg: transfer 1 SUI to 0x9eb94b1c301505d188f1b97914208b31a5419b57b2a3571169ad2165d41c2ffa
## 📚 Documentation
- [Sui Developer Documentation](https://docs.sui.io/)
- [MCP Protocol Documentation](https://modelcontextprotocol.io/)
TDQS
Scored across 7 tools
The tools have some overlap that could cause confusion, particularly between 'gen_mnemonic', 'gen_sui_accounts_by_mnemonic', and 'random-sui-account' which all relate to account generation with unclear boundaries. However, tools like 'faucet', 'sui-balance', and 'sui-transfer' have distinct purposes, and descriptions help differentiate them to some extent.
The naming is inconsistent with mixed conventions: 'faucet' and 'gen_mnemonic' use snake_case, 'gen_sui_accounts_by_mnemonic' uses snake_case with a verbose name, 'get_account_info_by_private_key' uses snake_case, 'random-sui-account' uses kebab-case, and 'sui-balance' and 'sui-transfer' use kebab-case. There is no discernible pattern, and the verb styles vary, making it chaotic.
With 7 tools, the count is well-scoped for the server's purpose of SUI blockchain operations. Each tool appears to earn its place by covering key functionalities like account management, balance checking, and transfers, without being overly heavy or thin for the domain.
The tool surface covers core SUI operations such as account creation, balance retrieval, and transfers, with no major dead ends. However, there are minor gaps, like missing tools for transaction history or smart contract interactions, which agents might need to work around but don't severely hinder basic workflows.