Back to Home
Setup Guide

Setup Guide

Add the Sui Developer MCP server to your IDE in just a few steps. Support for Claude Desktop, Cursor, and Windsurf with detailed platform-specific instructions.

Quick Start
Get up and running in under 2 minutes
1

Install Dependency

pnpm add -g mcp-remote
2

Add Configuration

Choose your IDE below for specific setup instructions

3

Restart & Test

Restart your IDE and ask: "What Sui tools are available?"

Claude Desktop Setup
Configure the Sui Developer MCP server in Claude Desktop

1Locate Configuration File

MacOS:

# Open the folder in Finder
open ~/Library/Application\ Support/Claude/

# Or edit directly with nano
nano ~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows:

# Navigate to the folder
%APPDATA%\Claude\

# Or edit directly
notepad %APPDATA%\Claude\claude_desktop_config.json

Linux:

# Edit directly
nano ~/.config/Claude/claude_desktop_config.json

2Add MCP Configuration

If the file doesn't exist, create it with this content:

{
  "mcpServers": {
    "sui-developer": {
      "command": "npx",
      "args": ["mcp-remote", "https://sui-developer-mcp.vercel.app/mcp"]
    }
  }
}

If you already have MCP servers, add the sui-developer entry:

{
  "mcpServers": {
    "existing-server": {
      "command": "your-existing-command",
      "args": ["your-existing-args"]
    },
    "sui-developer": {
      "command": "npx",
      "args": ["mcp-remote", "https://sui-developer-mcp.vercel.app/mcp"]
    }
  }
}

3Install Dependencies & Test

pnpm add -g mcp-remote

Important: Completely quit and restart Claude Desktop for changes to take effect.

Test the integration:

Ask Claude:

What Sui development tools do you have available?

Then try:

How do I create an NFT collection in Sui Move?
Available Tools
Once configured, you'll have access to these specialized Sui development tools

🧠 Ask Sui Move Expert

How do I implement a staking mechanism with time-locked rewards?

📚 Sui Documentation Search

Find information about dynamic fields and object composition

🔧 Ask Sui SDK Expert

Show me how to create and sign a programmable transaction in TypeScript

🐛 Sui Error Explainer

Explain 'InvalidObjectOwner' error and how to fix it

⚡ Sui Best Practices Guide

What are security best practices for DeFi protocols on Sui?
Troubleshooting
Common issues and solutions for MCP server setup

❌ "MCP server not found"

  • ✅ Install mcp-remote: pnpm add -g mcp-remote
  • ✅ Restart your IDE completely
  • ✅ Check JSON syntax in config file

❌ "Connection failed"

  • ✅ Verify internet connection
  • ✅ Test server: curl https://sui-developer-mcp.vercel.app/mcp
  • ✅ Check firewall settings

❌ "No tools available"

  • ✅ Wait a few seconds after restart
  • ✅ Try asking: "What tools do you have available?"
  • ✅ Verify the configuration JSON is properly formatted

✅ Success Indicators:

  • AI mentions using "Sui Developer MCP" tools
  • You get detailed Sui-specific responses
  • Code examples include Sui Move syntax
  • Error explanations are Sui-specific
Pro Tips
Get the most out of your Sui Developer MCP setup

Always install mcp-remote globally

before testing

Restart your IDE completely

after configuration changes

Start with simple questions

to verify the connection

Be specific in your questions

for better responses

Provide code context

when asking about errors

Test server availability

if experiencing connection issues

Ready to Start Building?

Your Sui Developer MCP server is configured and ready. Start building with AI assistance!