- Home
- MCP servers
- Sui MCP Tools
Sui MCP Tools
- typescript
4
GitHub Stars
typescript
Language
3 months ago
First Indexed
3 weeks ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"deanpluse-sui-mcp": {
"command": "npx",
"args": [
"-y",
"sui-mcp@latest"
]
}
}
}You can use the Sui MCP Tools to interact with the Sui blockchain through MCP, enabling convenient actions like obtaining testnet SUI, checking balances, and transferring funds. This toolkit is built with TypeScript for type safety and supports both remote and local runtime scenarios, so you can choose either an online runner or a locally built version that you host yourself.
How to use
You interact with the MCP server by running its command via your MCP client configuration. You have two practical options: use a remote, pre-packaged tool via npx, or run a locally built version with your own Node runtime. Both options expose the same set of MCP endpoints for faucet access, balance checks, and transfers.
How to install
Prerequisites you need before getting started are Node.js and a package manager (npm or yarn). Ensure you have an environment capable of running JavaScript/TypeScript tooling.
Option A: Use npx (recommended) to run the MCP tools without installing locally.
Option B: Build and run the MCP tools locally.
Configure your MCP client for the two available execution paths
{
"mcpServers": {
"sui_tools": {
"command": "npx",
"args": ["-y", "sui-mcp@latest"]
}
}
}
{
"mcpServers": {
"sui_tools_node": {
"command": "node",
"args": ["<absolute-path-to-your-project>/build/index.js"]
}
}
}
Additional configuration notes
If you prefer to install locally, clone the project, install dependencies, build, and then point your MCP client at the built index. You can then run the local server with the Node runtime and your built artifact.
Practical usage patterns
-
Use the faucet tool to obtain test SUI for development and testing scenarios.
-
Check the SUI balance of any address to track funds or verify transactions.
-
Transfer SUI to another address to simulate real-world flows or to seed accounts for testing.
Security and maintenance notes
Keep dependencies up to date and only run MCP tooling in trusted environments. When hosting locally, ensure the environment is secured and access is restricted to authorized users.
Troubleshooting tips
If you encounter issues starting the local runtime, verify that the build artifact path is correct and that your Node version matches the tooling requirements. Check that the MCP client is configured to point to the correct command and arguments.
Available tools
Testnet Faucet
Request SUI for development from the testnet faucet to seed accounts for testing.
Check SUI balance
Query the SUI balance for a specific address to monitor funds.
Transfer SUI
Send a specified amount of SUI from one address to another.