1.0.8 • Published 7 months ago

@mcp3/sui-navi v1.0.8

Weekly downloads
-
License
MIT
Repository
-
Last release
7 months ago

Sui Navi (Model Context Protocol)

A TypeScript implementation of the Model Context Protocol for the Navi Protocol on Sui Network.

Features

  • MCP server integration for Navi Protocol
  • Connect to Sui network nodes
  • Query Navi Protocol data and interact with Navi contracts
  • Retrieve pool information and user balances
  • Get health factors and available rewards
  • TypeScript support
  • Command-line interface

Prerequisites

  • Node.js (v16 or higher)
  • pnpm (v7 or higher)

Installation

  1. Clone the repository:
git clone <repository-url>
cd mcp3
  1. Install dependencies:
pnpm install
  1. Build the package:
pnpm --filter @mcp3/sui-navi build

Usage

As a library

import { NaviClient } from '@mcp3/sui-navi';

// Initialize the client
const client = new NaviClient({
  networkType: 'mainnet'
});

// Get pool information
const poolInfo = await client.getPoolInfo();
console.log(poolInfo);

As a CLI tool

# Get help
sui-navi --help

# Get pool information
sui-navi pool-info

# Get health factor for an address
sui-navi health-factor <address>

API Reference

The package exposes the following main classes and functions:

  • NaviClient: Main client for interacting with Navi Protocol
  • getPoolInfo(): Get information about Navi pools
  • getHealthFactor(): Get health factor for a specific address
  • getAvailableRewards(): Get available rewards for an address

License

MIT

1.0.8

7 months ago

1.0.8-rc.1

7 months ago

1.0.6-rc.1

7 months ago

1.0.5

7 months ago

1.0.4

7 months ago

1.0.3

7 months ago

1.0.2

7 months ago

1.0.1

7 months ago

1.0.0

7 months ago