Skip to content

Commit 2fe1611

Browse files
authored
[Portal] AI updated docs (#6536)
1 parent c549d59 commit 2fe1611

File tree

7 files changed

+321
-74
lines changed

7 files changed

+321
-74
lines changed
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
import { OpenSourceCard, Callout } from "@doc";
2+
3+
# Get Started
4+
5+
Learn how to get started with the thirdweb MCP server.
6+
7+
### Prerequisites
8+
9+
- Python 3.10 or higher
10+
- uv
11+
12+
### Run with uvx
13+
```bash
14+
THIRDWEB_SECRET_KEY=... \
15+
uvx thirdweb-mcp
16+
```
17+
18+
### Install and run with pipx
19+
20+
```bash
21+
pipx install thirdweb-mcp
22+
23+
THIRDWEB_SECRET_KEY=... \
24+
thirdweb-mcp
25+
```
26+
27+
### Install from source
28+
29+
```bash
30+
git clone https://github.com/thirdweb-dev/ai.git thirdweb-ai
31+
cd thirdweb-ai/python/thirdweb-mcp
32+
uv sync
33+
```
34+
35+
## Configuration
36+
37+
The thirdweb MCP server requires configuration based on which services you want to enable:
38+
39+
1. **thirdweb Secret Key**: Required for Nebula and Insight services. Obtain from the [thirdweb dashboard](https://thirdweb.com/dashboard).
40+
2. **Chain IDs**: Blockchain network IDs to connect to (e.g., 1 for Ethereum mainnet, 137 for Polygon).
41+
3. **Engine Configuration**: If using the Engine service, you'll need the Engine URL and authentication JWT.
42+
43+
You can provide these through command-line options or environment variables.
44+
45+
## Usage
46+
47+
### Command-line options
48+
49+
```bash
50+
# Basic usage with default settings (stdio transport with Nebula and Insight)
51+
THIRDWEB_SECRET_KEY=... thirdweb-mcp
52+
53+
# Using SSE transport on a custom port
54+
THIRDWEB_SECRET_KEY=... thirdweb-mcp --transport sse --port 8080
55+
56+
# Enabling all services with specific chain IDs
57+
THIRDWEB_SECRET_KEY=... thirdweb-mcp --chain-id 1 --chain-id 137 \
58+
--engine-url YOUR_ENGINE_URL \
59+
--engine-auth-jwt YOUR_ENGINE_JWT \
60+
--engine-backend-wallet-address YOUR_ENGINE_BACKEND_WALLET_ADDRESS
61+
```
62+
63+
### Environment variables
64+
65+
You can also configure the MCP server using environment variables:
66+
67+
- `THIRDWEB_SECRET_KEY`: Your thirdweb API secret key
68+
- `THIRDWEB_ENGINE_URL`: URL endpoint for thirdweb Engine service
69+
- `THIRDWEB_ENGINE_AUTH_JWT`: Authentication JWT token for Engine
70+
- `THIRDWEB_ENGINE_BACKEND_WALLET_ADDRESS`: Wallet address for Engine backend
71+
72+
## Available Services
73+
74+
### Nebula
75+
76+
Autonomous onchain execution and analysis:
77+
- Analyze smart contract code
78+
- Contract interactions and deployments
79+
- Autonomous onchain tasks execution
80+
81+
### Insight
82+
83+
Offers blockchain data analysis capabilities:
84+
- Query on-chain data across multiple networks
85+
- Analyze transactions, blocks, and smart contract events
86+
- Monitor wallet activities and token movements
87+
88+
### Engine
89+
90+
Integrates with thirdweb's backend infrastructure:
91+
- Deploy smart contracts
92+
- Interact with deployed contracts
93+
- Manage wallet connections and transactions
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Claude Desktop
2+
3+
4+
Learn how to add the MCP server to Claude Desktop:
5+
6+
1. Install the MCP: `pipx install thirdweb-mcp`
7+
8+
2. Create or edit the Claude Desktop configuration file at:
9+
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
10+
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
11+
- Linux: `~/.config/Claude/claude_desktop_config.json`
12+
13+
3. Add the following configuration:
14+
15+
```json
16+
{
17+
"mcpServers": {
18+
"thirdweb-mcp": {
19+
"command": "thirdweb-mcp",
20+
"args": [], // add `--chain-id` optionally
21+
"env": {
22+
"THIRDWEB_SECRET_KEY": "your thirdweb secret key from dashboard",
23+
"THIRDWEB_ENGINE_URL": "(OPTIONAL) your engine url",
24+
"THIRDWEB_ENGINE_AUTH_JWT": "(OPTIONAL) your engine auth jwt",
25+
"THIRDWEB_ENGINE_BACKEND_WALLET_ADDRESS": "(OPTIONAL) your engine backend wallet address",
26+
},
27+
}
28+
}
29+
}
30+
```
31+
32+
4. Restart Claude Desktop for the changes to take effect.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
### MCP Clients
3+
4+
Learn how to integrate the thirdweb MCP server with various clients.
5+
6+
This server can be integrated with any client that supports the Model Context Protocol:
7+
8+
1. Run the MCP server with the appropriate configuration
9+
2. Connect your MCP client to the server using the selected transport (stdio or SSE)
10+
3. Access thirdweb services through the exposed MCP tools

0 commit comments

Comments
 (0)