Frequently Asked Questions (FAQ) about the Sui Agent Kit

Q: What is the Sui Agent Kit? A: The Sui Agent Kit is a Node.js server application built with TypeScript that simplifies DeFi development on the Sui blockchain, particularly for the SuiLend protocol. It abstracts away the complexities of the SuiLend SDK, exposing its features as intuitive “tools” through the Model-Context Protocol (MCP).

Q: What is MCP (Model Context Protocol)? A: MCP is an open protocol that standardizes how applications provide context to LLMs (Large Language Models). In the context of the Sui Agent Kit, the MCP server acts as a bridge, allowing AI models to access and interact with external data sources and tools on the Sui blockchain.

Q: What are some use cases for the Sui Agent Kit? A: Use cases include automated health factor management for SuiLend positions, yield farming bots, DeFi dashboards with one-click management, AI-powered advisors for optimal DeFi strategies, and custom SuiLend tooling for advanced users.

Q: What core components are included in the Sui Agent Kit? A: The core components are the MCP Server (src/mcp/server.ts), SuiLend SDK Integration (src/protocols/suilend/), Configuration (src/protocols/suilend/config.ts), Input Validation (src/mcp/zodSchemas/), and a Tool-Based API.

Q: What MystenSui (Core Sui Functionality) tools are available? A: Tools include mystenSui_getSuiBalance, mystenSui_getTokenMetadata, mystenSui_getUserTokenBalance, mystenSui_transferSui, mystenSui_transferSuiToMany, mystenSui_transferFungTokensToMany, and mystenSui_getUserRecentTxs.

Q: What SuiSpring (Liquid Staking) tools are available? A: Tools include springSui_discoverLstPools, springSui_getLstSuiExchangeRate, springSui_getUserLstDetails, springSui_getSpringSuiPoolApys, springSui_stakeSuiForSpringSuiLst, springSui_stakeSuiForParaSui, and springSui_redeemSpringSuiLstForSui.

Q: What Suilend (Lending & Borrowing) tools are available? A: Tools include suilend_getSuilendMarketAssets, suilend_ensureSuilendObligation, suilend_getUserObligationInfo, suilend_depositToSuilend, suilend_getObligationDetails, suilend_withdrawFromSuilend, suilend_borrowFromSuilend, suilend_repayToSuilend, and suilend_getObligationHistory.

Q: What are the prerequisites for using the Sui Agent Kit? A: You need Node.js (version 18.x or later), npm or yarn, a Sui wallet private key in Bech32 format, and Git.

Q: How do I install the Sui Agent Kit? A: Clone the repository, navigate to the directory, and run npm install or yarn install.

Q: How do I configure the Sui Agent Kit? A: Create a .env file in the root directory and add your Sui private key (SUI_MAINNET_PRIVATE_KEY) and optionally the Sui RPC URL (SUI_RPC_URL).

Q: How do I run the Sui Agent Kit server? A: For development, use npm run dev. For production, build the kit with npm run build and then run npm start.

Q: How do I connect an MCP client to the Sui Agent Kit? A: Use an MCP client like @modelcontextprotocol/inspector and configure it with an mcp.json file that specifies how to launch and manage your Sui Agent Kit server process.

Q: What is the current status of the project? A: The core infrastructure, MystenSui integration, SpringSui integration, and Suilend integration are stable. Steamm (DEX) integration is currently disabled but planned for future implementation. Testing is in place, with further test coverage a priority.

Q: How can I contribute to the Sui Agent Kit? A: You can contribute by reporting bugs, suggesting features, improving documentation, or submitting pull requests for new tools or protocol integrations.

Q: Where can I find the repositories for the Sui Agent Kit? A: You can find the Navi Kit repository at https://github.com/ParaDevsAI/Sui-Agent-Kit-Navi and the SuiLend+SuiSpring Kit repository at https://github.com/ParaDevsAI/Sui-Agent-Kit-SuiLend-SuiSpring.

Q: How does the UBOS platform enhance the Sui Agent Kit? A: UBOS provides AI Agent Orchestration, Enterprise Data Connectivity, Custom AI Agent Development, and Multi-Agent Systems capabilities, which when integrated with the Sui Agent Kit unlock full potential of automated DeFi and gains competitive edge in the rapidly evolving world of decentralized finance.