使用说明
Sui MCP服务器
用于Sui区块链开发和交互的模型上下文协议(MCP)服务器。该服务器使AI代理能够通过标准化的接口与Sui区块链进行交互。
特性
- 117工具 隋朝综合发展的12个范畴
- 代理商友好设计 具有清晰的描述、安全警告和先决条件提示
- 多网络支持 适用于本地网、开发网、测试网和主网
- 安全第一 -默认情况下禁用主网写入操作
- 资源提供程序 获取环境信息、天然气价格和本地网络状态
- 引导提示 用于部署和调试等常见工作流
- 字节码分析 -解析、分析和反汇编Move字节码
快速开始
先决条件
- 货物锈蚀1.75+
- Sui CLI(用于本地网络操作)
- 正在运行的Sui网络(本地网、开发网、测试网或主网)
安装
# Clone the repository
git clone https://github.com/your-org/sui-mcp.git
cd sui-mcp
# Copy environment configuration
cp .env.example .env
# Build the server
cargo build --release
# The binary will be at target/release/sui-mcp
跑步
# Start with default settings (localnet)
./target/release/sui-mcp
# Or with specific network
SUI_NETWORK=devnet ./target/release/sui-mcp
配置
配置是通过环境变量完成的。看 .env.example 对于所有选项。
| 变量 | 默认值 | 描述 |
|---|---|---|
SUI_NETWORK |
localnet |
网络:本地网、开发网、测试网、主网、自定义 |
SUI_RPC_URL |
(每个网络) | 自定义RPC端点 |
SUI_GRAPHQL_URL |
(每个网络) | 自定义GraphQL端点 |
RUST_LOG |
sui_mcp=info |
日志级别配置 |
SUI_MCP_LOG_FILE |
(无) | 记录到文件而不是stderr |
工具类别
| 类别 | 工具 | 描述 |
|---|---|---|
| 环境 | 4 | CLI检测、配置、密钥库信息 |
| 账户 | 11 | 地址管理、余额、水龙头、转账 |
| 对象 | 15 | 对象查询、动态字段、所有权跟踪 |
| 交易 | 12 | 建造、签署、执行、试运行、PTB施工 |
| 包裹 | 15 | 构建、测试、发布、升级、覆盖、文档 |
| 网络 | 12 | 网络信息、本地网络管理、状态检查 |
| 事件 | 6 | 按类型、模块、发送方、交易查询事件 |
| 监控 | 6 | 纪元、检查点、验证器、系统状态 |
| 气体 | 5 | 分析、估算、成本分析 |
| 调试 | 5 | 错误解释、中止代码、事件解码 |
| 安全 | 17 | 字节码分析、能力跟踪、审计 |
| 公用事业 | 9 | 编码、散列、BCS、地址转换 |
资源
服务器公开这些MCP资源:
sui://environment-当前网络配置sui://version-服务器和协议版本sui://addresses-已知地址sui://gas-price-当前参考天然气价格sui://localnet/status-本地网络健康状况(如适用)
提示
常见工作流的预构建提示:
- 部署包 -指导构建、测试和部署
- 调试事务 -分析失败的交易
- 分析对象 -深入了解对象结构
- 审计包 -部署包的安全审计
- 优化交易 -天然气优化建议
建筑
sui-mcp/
├── crates/
│ ├── sui-mcp-server/ # Main binary, request routing
│ ├── sui-mcp-core/ # Shared types, errors, network config
│ ├── sui-mcp-tools/ # All tool implementations
│ ├── sui-mcp-resources/ # Resource providers
│ └── sui-mcp-prompts/ # Prompt templates
├── docs/
│ └── IMPLEMENTATION_GUIDE.md
└── specs/ # Original specifications
变更日志
- sui-mcp服务器 -主服务器二进制文件
- sui-mcp工具 -工具实施
- sui-mcp核心 -核心类型和公用设施
- sui-mcp资源 -资源提供者
- sui-mcp提示 -提示模板
安全特性
- 主网保护 -默认情况下,主网上的写入操作被禁用
- 先干跑 -工具鼓励在执行前进行模拟运行
- 明确警告 -危险操作有明显的警告
- 只读提示 -工具在适用时标记为只读
发展
# Run tests
cargo test
# Run with debug logging
RUST_LOG=sui_mcp=debug cargo run
# Build release binary
cargo build --release
整合
克劳德桌面
添加到您的Claude Desktop配置中:
{
"mcpServers": {
"sui": {
"command": "/path/to/sui-mcp",
"env": {
"SUI_NETWORK": "devnet"
}
}
}
}
程序化使用
默认情况下,服务器使用stdio传输,与任何MCP客户端兼容:
# Pipe JSON-RPC messages via stdin/stdout
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | ./sui-mcp
许可证
MIT许可证-有关详细信息,请参阅许可证文件。
贡献
欢迎投稿!请在提交PR之前阅读我们的投稿指南。
