sui-mcp

🚀 Sui MCP 工具包

这是一个基于 Sui 区块链的 Model Context Protocol (MCP) 工具包。该工具包提供了与 Sui 区块链交互的功能，并集成了 MCP SDK 以实现模型上下文协议的相关特性，能有效助力开发者在 Sui 区块链上开展工作。

🚀 快速开始

Sui MCP 工具包为开发者提供了与 Sui 区块链交互的便捷途径，集成 MCP SDK 实现了模型上下文协议的相关功能。下面将详细介绍其安装、配置及使用方法。

✨ 主要特性

• 💪 使用 TypeScript 开发，提供类型安全，让开发过程更加稳定可靠。
• 🔗 深度集成 Sui 区块链功能，无缝衔接区块链生态。
• 🌐 支持多种网络环境（测试网、开发网），满足不同开发阶段的需求。
• 🛠 完整的构建脚本和开发工具链，提高开发效率。

📦 安装指南

有以下两种方式可以安装和配置 Sui MCP 工具包：

方法 1：使用 npx（推荐）

这是最简单的方式，只需将以下配置添加到您的 Claude Desktop 配置文件中：

{
  "mcpServers": {
    "sui-tools": {
      "command": "npx",
      "args": ["-y", "sui-mcp@latest"]
    }
  }
}

方法 2：本地构建

1. 克隆代码并安装依赖项：

git clone https://github.com/0xdwong/sui-mcp.git
cd sui-mcp
yarn install

2. 构建项目：

yarn build

3. 使用本地构建配置 Claude Desktop：

{
  "mcpServers": {
    "sui-tools": {
      "command": "node",
      "args": ["<absolute-path-to-your-project>/build/index.js"]
    }
  }
}

配置文件位置

Claude Desktop 的配置文件位于：

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

您可以通过 Claude Desktop 访问此文件：Claude > 设置 > 开发者 > 编辑配置。修改后重启 Claude Desktop 以使更改生效。

🛠 可用工具

• 测试网 Faucet

  示例：请求 0x9eb94b1c301505d188f1b97914208b31a5419b57b2a3571169ad2165d41c2ffa 的 SUI

• 查询 SUI 余额

  示例：查询 0x9eb94b1c301505d188f1b97914208b31a5419b57b2a3571169ad2165d41c2ffa 的 SUI 余额

• 转账 SUI

  示例：向 0x9eb94b1c301505d188f1b97914208b31a5419b57b2a3571169ad2165d41c2ffa 转账 1 SUI

📚 详细文档

• Sui 开发者文档
• MCP 协议文档