Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions apps/portal/src/app/nebula/mcp-server/get-started/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
import { OpenSourceCard, Callout } from "@doc";

# Get Started

Learn how to get started with the thirdweb MCP server.

### Prerequisites

- Python 3.10 or higher
- uv

### Run with uvx
```bash
THIRDWEB_SECRET_KEY=... \
uvx thirdweb-mcp
```

### Install and run with pipx

```bash
pipx install thirdweb-mcp

THIRDWEB_SECRET_KEY=... \
thirdweb-mcp
```

### Install from source

```bash
git clone https://github.com/thirdweb-dev/ai.git thirdweb-ai
cd thirdweb-ai/python/thirdweb-mcp
uv sync
```

## Configuration

The thirdweb MCP server requires configuration based on which services you want to enable:

1. **thirdweb Secret Key**: Required for Nebula and Insight services. Obtain from the [thirdweb dashboard](https://thirdweb.com/dashboard).
2. **Chain IDs**: Blockchain network IDs to connect to (e.g., 1 for Ethereum mainnet, 137 for Polygon).
3. **Engine Configuration**: If using the Engine service, you'll need the Engine URL and authentication JWT.

You can provide these through command-line options or environment variables.

## Usage

### Command-line options

```bash
# Basic usage with default settings (stdio transport with Nebula and Insight)
THIRDWEB_SECRET_KEY=... thirdweb-mcp

# Using SSE transport on a custom port
THIRDWEB_SECRET_KEY=... thirdweb-mcp --transport sse --port 8080

# Enabling all services with specific chain IDs
THIRDWEB_SECRET_KEY=... thirdweb-mcp --chain-id 1 --chain-id 137 \
--engine-url YOUR_ENGINE_URL \
--engine-auth-jwt YOUR_ENGINE_JWT \
--engine-backend-wallet-address YOUR_ENGINE_BACKEND_WALLET_ADDRESS
```

### Environment variables

You can also configure the MCP server using environment variables:

- `THIRDWEB_SECRET_KEY`: Your thirdweb API secret key
- `THIRDWEB_ENGINE_URL`: URL endpoint for thirdweb Engine service
- `THIRDWEB_ENGINE_AUTH_JWT`: Authentication JWT token for Engine
- `THIRDWEB_ENGINE_BACKEND_WALLET_ADDRESS`: Wallet address for Engine backend

## Available Services

### Nebula

Autonomous onchain execution and analysis:
- Analyze smart contract code
- Contract interactions and deployments
- Autonomous onchain tasks execution

### Insight

Offers blockchain data analysis capabilities:
- Query on-chain data across multiple networks
- Analyze transactions, blocks, and smart contract events
- Monitor wallet activities and token movements

### Engine

Integrates with thirdweb's backend infrastructure:
- Deploy smart contracts
- Interact with deployed contracts
- Manage wallet connections and transactions
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Claude Desktop


Learn how to add the MCP server to Claude Desktop:

1. Install the MCP: `pipx install thirdweb-mcp`

2. Create or edit the Claude Desktop configuration file at:
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
- Linux: `~/.config/Claude/claude_desktop_config.json`

3. Add the following configuration:

```json
{
"mcpServers": {
"thirdweb-mcp": {
"command": "thirdweb-mcp",
"args": [], // add `--chain-id` optionally
"env": {
"THIRDWEB_SECRET_KEY": "your thirdweb secret key from dashboard",
"THIRDWEB_ENGINE_URL": "(OPTIONAL) your engine url",
"THIRDWEB_ENGINE_AUTH_JWT": "(OPTIONAL) your engine auth jwt",
"THIRDWEB_ENGINE_BACKEND_WALLET_ADDRESS": "(OPTIONAL) your engine backend wallet address",
},
}
}
}
```

4. Restart Claude Desktop for the changes to take effect.
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

### MCP Clients

Learn how to integrate the thirdweb MCP server with various clients.

This server can be integrated with any client that supports the Model Context Protocol:

1. Run the MCP server with the appropriate configuration
2. Connect your MCP client to the server using the selected transport (stdio or SSE)
3. Access thirdweb services through the exposed MCP tools
Loading
Loading