Mcp3

🚀 MCP3 Monorepo

This monorepo contains implementations of the Model Context Protocol (MCP3) for different blockchain networks, providing tools and services for blockchain data access and interaction.

🚀 Quick Start

How to Use MCP3 on SUI

MCP3 offers a comprehensive toolset for interacting with the SUI blockchain. The main package @mcp3/sui provides a CLI and API for common operations, while dedicated packages offer additional features for specific protocols and use cases.

Using Claude Desktop

Add the following to your claude desktop configuration:

{
  ...
  "mcpServers": {
    ...
    "mcp3-sui": {
      "command": "npx",
      "args": [
        "-y",
        "@mcp3/sui",
        "start",
        "-t"
      ]
    }
    ...
  }
}

Using the CLI

Run the following command to get a list of available commands and options:

npx @mcp3/sui --help

✨ Features

Package Classification

Core Packages

• @mcp3/common: Shared utilities, types, and tools used across all implementations.
• @mcp3/eth: MCP3 implementation for the Ethereum network.
• @mcp3/sui: MCP3 implementation for the SUI network.

SUI Ecosystem Packages

• @mcp3/sui-base: Basic utilities and tools for the SUI network.
• @mcp3/sui-wallets: Wallet management tools for the SUI network.
• @mcp3/sui-cetus: Integration of the Cetus protocol in the SUI network.
• @mcp3/sui-navi: Integration of the Navi protocol in the SUI network.

Data Integration Packages

• @mcp3/dex-screener: Integration of the DexScreener API with MCP3.
• @mcp3/defilama: Integration of the DeFiLlama API with MCP3.

Transaction Management

• @mcp3/transaction-server: A server that handles transactions and provides a transaction UI.
• @mcp3/transaction-ui: A React component library for transaction signing and submission UI.

📦 Installation

Development

This project uses pnpm as the package manager and workspaces to manage the monorepo.

Prerequisites

• Node.js (v18 or higher)
• pnpm (v8 or higher)

Setup

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Clean build files
pnpm clean

# Test the code
pnpm test

# Start the development server
pnpm dev

🤝 Contribution

To contribute to this project, follow these steps:

1. Fork the repository: git clone https://github.com/sentioxyz/mcp3.git
2. Create a feature branch: git checkout -b feature/your-feature-name
3. Commit your changes: git add . && git commit -m 'Your commit message'
4. Push to your forked repository and open a Pull Request.

📄 License

The project is released under the LICENSE.