You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/getting-started.md
+38-32Lines changed: 38 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,50 +2,55 @@
2
2
3
3
This tutorial will guide you through installing and using HoloViz MCP for the first time. By the end, you'll have HoloViz MCP running and be able to ask your AI assistant questions about Panel components!
4
4
5
-
## What You'll Learn
6
-
7
-
- How to install HoloViz MCP
8
-
- How to configure it with your AI assistant (VS Code, Claude Desktop, or Cursor)
9
-
- How to use it to get help building Panel applications
10
-
- How to verify everything is working correctly
11
-
12
-
## Prerequisites
13
-
14
-
Before you begin, ensure you have:
15
-
16
-
-**Python 3.11 or newer** installed on your system
Open your terminal and install HoloViz MCP as a uv tool:
27
25
28
26
```bash
29
-
uv tool install holoviz-mcp[panel-extensions]
27
+
uv tool install holoviz-mcp
30
28
```
31
29
32
-
This command installs HoloViz MCP along with common Panel extensions, making them available for your AI assistant to reference.
30
+
This command installs HoloViz MCP, making it available for your AI assistant to reference.
31
+
32
+
!!! tip "What's happening?"
33
+
The uv tool manager creates an isolated environment for HoloViz MCP and installs all necessary dependencies.
33
34
34
-
**What's happening?** The uv tool manager creates an isolated environment for HoloViz MCP and installs all necessary dependencies.
35
+
## Step 2: Install Chromium
35
36
36
-
## Step 2: Create the Documentation Index
37
+
Install [Chromium](https://playwright.dev/docs/browsers) to enable the holoviz-mcp server to take screenshots:
38
+
39
+
```bash
40
+
uvx holoviz-mcp install chromium
41
+
```
42
+
43
+
## Step 3: Create the Documentation Index
37
44
38
45
HoloViz MCP needs to index the HoloViz documentation to provide intelligent answers. Run:
39
46
40
47
```bash
41
48
uvx holoviz-mcp update index
42
49
```
43
50
44
-
**⏱️ This takes 5-10 minutes on first run** as it downloads and indexes documentation from Panel, hvPlot, and other HoloViz libraries.
45
-
46
-
**Tip**: While this runs, continue to Step 3 to configure your IDE!
51
+
**⏱️ This takes 5-10 minutes** as it downloads and indexes documentation from Panel, hvPlot, and other HoloViz libraries.
47
52
48
-
## Step 3: Configure Your AI Assistant
53
+
## Step 4: Configure Your AI Assistant
49
54
50
55
Choose your AI assistant and follow the appropriate configuration:
51
56
@@ -54,7 +59,7 @@ Choose your AI assistant and follow the appropriate configuration:
54
59
1. In VS Code, open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
55
60
2. Type "MCP: Add Server..." and press Enter
56
61
3. Choose "Command (stdio)"
57
-
4. Choose "uvx holoviz-mcp[panel-extensions]" as the "Command to run"
62
+
4. Choose "uvx holoviz-mcp" as the "Command to run"
58
63
5. Enter "holoviz" as the "Server ID"
59
64
6. Choose "Global"
60
65
@@ -66,7 +71,7 @@ This will add the below configuration to you global `mcp.json` file.
66
71
"holoviz": {
67
72
"type": "stdio",
68
73
"command": "uvx",
69
-
"args": ["holoviz-mcp[panel-extensions]"]
74
+
"args": ["holoviz-mcp"]
70
75
}
71
76
},
72
77
"inputs": []
@@ -89,7 +94,7 @@ Please refer to the [VS Code | MCP Servers](https://code.visualstudio.com/docs/c
89
94
"mcpServers": {
90
95
"holoviz": {
91
96
"command": "uvx",
92
-
"args": ["holoviz-mcp[panel-extensions]"]
97
+
"args": ["holoviz-mcp"]
93
98
}
94
99
}
95
100
}
@@ -107,13 +112,13 @@ Please refer to the [VS Code | MCP Servers](https://code.visualstudio.com/docs/c
107
112
{
108
113
"name": "holoviz",
109
114
"command": "uvx",
110
-
"args": ["holoviz-mcp[panel-extensions]"]
115
+
"args": ["holoviz-mcp"]
111
116
}
112
117
```
113
118
114
119
4. Save and restart Cursor
115
120
116
-
## Step 4: Verify Installation
121
+
## Step 5: Verify Installation
117
122
118
123
Let's verify that HoloViz MCP is working correctly!
119
124
@@ -152,7 +157,7 @@ Open a chat with your AI assistant and try these questions:
152
157
153
158
If your AI assistant provides detailed, accurate answers with specific Panel component information, congratulations! HoloViz MCP is working correctly! 🎉
154
159
155
-
## Step 5: Build Your First Dashboard
160
+
## Step 6: Build Your First Dashboard
156
161
157
162
Now that everything is set up, let's build a simple dashboard:
0 commit comments