Osmosis Agent Toolkit

🚀 Osmosis Agent Toolkit

This project provides a set of packages for building Osmosis agent toolkits, enabling large language models (LLMs) to interact with the Osmosis protocol.

🚀 Quick Start

This repository contains a series of packages used to build the Osmosis agent toolkit. Large language models (LLMs) can use these tools to interact with the Osmosis protocol.

✨ Features

@osmosis-agent-toolkit/core

The core package contains the most fundamental functions used by other packages. Here, registry data, query clients, and signing and broadcasting logic are defined.

@osmosis-agent-toolkit/ai-sdk

An implementation of Vercel's AI SDK in the Osmosis agent toolkit.

@osmosis-agent-toolkit/mcp

An implementation of the Model Context Protocol (MCP) server in the Osmosis agent toolkit.

Using Claude Desktop or Cursor

Add the following content to your claude_desktop_config.json or .cursor/mcp.json. For more information, refer to here.

{
    "mcpServers": {
        "Osmosis": {
            "command": "npx",
            "args": [
                "-y",
                "@osmosis-agent-toolkit/mcp"
            ],
            "env": {
                "OSMOSIS_MNEMONIC": "<your mnemonic here>"
            }
        }
    }
}

📦 Installation

Use yarn or bun to install dependencies:

bun i

💻 Usage Examples

Basic Usage

Start the local development environment:

bun run dev

Advanced Usage

Build the project:

bun run build