0.1.7 • Published 2 months ago

@suiware/mcp v0.1.7

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 months ago

@suiware/mcp

An stdio MCP server with built-in @suiware/ai-tools and API to use in your apps.

Available Tools

  • get-address (e.g. "show my address")
  • get-wallet-balance (e.g. "my balances")
  • swap-coin (e.g. "swap 1 sui to wal")
  • transfer-coin (e.g. "send 1 sui to @suiware")
  • stake-sui (e.g. "stake 1 sui")
  • unstake-sui (e.g. "unstake sui")

MCP SERVER

Prerequisites

Configuration

Create an .env file in your project folder with the following variables in it:

SUI_PRIVATE_KEY= # "suiprivkey...."
SUI_NETWORK= # "testnet" or "mainnet"

Usage

Option 1. Run the Suiware MCP server directly

When you run the server, supply the --env-config-file="file/path/.env" param with the .env file path.

pnpx @suiware/mcp --env-config-file="file/path/.env"

You may omit the optional --env-config-file param if you're providing the config variables in any other way available to you.

Option 2. Connect to the Suiware MCP server through your AI app

Use Claude Code or any other app which supports plugging in third-party MCP servers to connect to the Suiware MCP server.

Check out claude_config.example.json for Claude apps. And make sure your --env-config-file value in it to the location of your .env file which contains SUI_PRIVATE_KEY and SUI_NETWORK variables.

With Claude Code:

claude -p "get my balances and address" --mcp-config packages/mcp/claude_config.example.json --allowedTools "mcp__suiware-mcp__get-wallet-balance,mcp__suiware-mcp__get-address"

List the tools you want to use through the --allowedTools param (comma-separated).

With Claude Desktop:

I haven't manage to connect the MCP to Claude Desktop on Linux because it doesn't support this OS but you can follow the official MCP usage guide for Claude Desktop to make it work for you.

Test

pnpx @modelcontextprotocol/inspector pnpx @suiware/mcp --env-config-file="file/path/.env"

API

Currently the API is super-simple - it's just one function startSuiwareMcpServer() which lets you start the MCP server from your code.

Installation

To create and start the server from your own codebase, add the @suiware/mcp package as a dependency.

pnpm add @suiware/mcp

Usage

import { startSuiwareMcpServer } from '@suiware/mcp'

async function main() {
  // Assuming you have .env file with Sui account access details in the same folder.
  await startSuiwareMcpServer({ name: 'Suiware MCP Server', version: '0.1.0' })
}

main().catch(console.error)

Changelog

Find the detailed changelog in the package root.

0.1.7

2 months ago

0.1.6

2 months ago

0.1.5

2 months ago

0.1.5-alpha.5

2 months ago

0.1.5-alpha.4

2 months ago

0.1.5-alpha.3

2 months ago

0.1.5-alpha.2

2 months ago

0.1.5-alpha.1

2 months ago

0.1.5-alpha.0

2 months ago

0.1.4

2 months ago

0.1.3

3 months ago

0.1.2

3 months ago

0.1.1

3 months ago

0.1.0

3 months ago

0.1.0-alpha.1

3 months ago