DocumentationOpen App

MCP Setup

Connect the Gearbox MCP server to your AI coding tool and start interacting with the protocol.

Installation

Add the Gearbox MCP server to your client. The configuration is the same across all clients — just the config file location differs.

JSON
{ "mcpServers": { "gearbox": { "command": "npx", "args": ["@gearbox-protocol/mcp-server"] } } }

Where to put this config

ClientConfig File
Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows)
Claude Code.claude/settings.json (project) or ~/.claude/settings.json (global)
VS Code (Copilot).vscode/settings.json — use "mcp": { "servers": { ... } } format
Cursor.cursor/mcp.json in project root
Windsurf~/.codeium/windsurf/mcp_config.json

After adding the config, restart your client.

Verify the Connection

Once configured, restart your MCP client and verify the connection by asking the agent to list available opportunities:

List all available Gearbox yield opportunities on Mainnet

The agent should call list_opportunities and return a list of pools and strategies with APY, TVL, and access information. If you see results, the setup is working.

What You Can Do

The MCP server exposes 16 tools organized by the agent loop stages:

Discover

ToolDescription
list_opportunitiesFind opportunities across chains, filtered by asset type, chain, and kind
list_poolsList pool (passive lending) opportunities
list_strategiesList strategy (leveraged) opportunities

Analyze

ToolDescription
get_pool_detailFull pool detail: allowed tokens, rates, capacity
get_strategy_detailStrategy detail: leverage, collaterals, exit modes
get_metric_historyHistorical APY, TVL, utilization over a time period
get_eventsRecent parameter changes and governance events
get_curatorCurator profile: track record, bad debt history, managed TVL
get_token_infoToken profiles and metadata
get_token_liquidityOn-chain liquidity depth and market data

Propose

ToolDescription
prepare_depositBuild a deposit transaction for a pool
prepare_positionBuild a leveraged position transaction for a strategy

Preview

ToolDescription
simulate_depositSimulate a deposit and see expected outcomes
simulate_positionSimulate a leveraged position opening

Execute & Monitor

ToolDescription
execute_transactionSubmit a prepared transaction to the blockchain
get_pool_statusCurrent pool state: rates, utilization, TVL
get_position_statusCurrent position health factor, value, and alerts

Multi-Chain Support

All tools are chain-aware. You can query across multiple chains or target a specific one:

Show me stablecoin opportunities on both Mainnet and Monad

Get pool details for 0x... on chain 1

Every entity reference includes a chainId, so there is no ambiguity when the same token or contract exists on multiple chains.

Next Steps

  • First Agent — walk through a complete discover-to-preview flow using MCP tools
  • Getting Started — overview of both integration paths