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/how-to/ide-configuration.md
+28-34Lines changed: 28 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,31 +4,22 @@ This guide covers configuring HoloViz MCP with different IDEs and AI assistants.
4
4
5
5
## VS Code + GitHub Copilot
6
6
7
-
### Quick Install
8
-
9
-
Click to install automatically:
10
-
11
-
[](https://vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522holoviz%2522%252C%2522command%2522%253A%2522uvx%2522%252C%2522args%2522%253A%255B%2522holoviz-mcp%255Bpanel-extensions%255D%2522%255D%257D)
12
-
13
-
### Manual Configuration
14
-
15
7
1. Open VS Code
16
8
2. Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS)
17
9
3. Type "MCP: Edit Settings" and press Enter
18
10
4. Add this configuration to your `mcp.json`:
19
11
20
-
```json
21
-
{
22
-
"servers": {
23
-
"holoviz": {
24
-
"type": "stdio",
25
-
"command": "uvx",
26
-
"args": ["holoviz-mcp"]
27
-
}
28
-
},
29
-
"inputs": []
30
-
}
31
-
```
12
+
```json
13
+
{
14
+
"servers": {
15
+
"holoviz": {
16
+
"type": "stdio",
17
+
"command": "holoviz-mcp"
18
+
}
19
+
},
20
+
"inputs": []
21
+
}
22
+
```
32
23
33
24
5. Save and restart VS Code
34
25
@@ -61,8 +52,7 @@ Click to install automatically:
61
52
{
62
53
"mcpServers": {
63
54
"holoviz": {
64
-
"command": "uvx",
65
-
"args": ["holoviz-mcp"]
55
+
"command": "holoviz-mcp"
66
56
}
67
57
}
68
58
}
@@ -90,8 +80,7 @@ After restarting Claude Desktop, look for the MCP indicator (🔌) in the interf
90
80
```json
91
81
{
92
82
"name": "holoviz",
93
-
"command": "uvx",
94
-
"args": ["holoviz-mcp"]
83
+
"command": "holoviz-mcp"
95
84
}
96
85
```
97
86
@@ -105,8 +94,7 @@ Add to your Windsurf MCP configuration:
105
94
{
106
95
"mcpServers": {
107
96
"holoviz": {
108
-
"command": "uvx",
109
-
"args": ["holoviz-mcp"]
97
+
"command": "holoviz-mcp"
110
98
}
111
99
}
112
100
}
@@ -119,8 +107,7 @@ For other MCP-compatible clients, use the standard configuration:
119
107
```json
120
108
{
121
109
"name": "holoviz",
122
-
"command": "uvx",
123
-
"args": ["holoviz-mcp"]
110
+
"command": "holoviz-mcp"
124
111
}
125
112
```
126
113
@@ -135,8 +122,7 @@ You can customize server behavior using environment variables:
135
122
"servers": {
136
123
"holoviz": {
137
124
"type": "stdio",
138
-
"command": "uvx",
139
-
"args": ["holoviz-mcp"],
125
+
"command": "holoviz-mcp",
140
126
"env": {
141
127
"HOLOVIZ_MCP_LOG_LEVEL": "DEBUG"
142
128
}
@@ -154,8 +140,7 @@ Use a custom directory for configuration and data:
154
140
"servers": {
155
141
"holoviz": {
156
142
"type": "stdio",
157
-
"command": "uvx",
158
-
"args": ["holoviz-mcp"],
143
+
"command": "holoviz-mcp",
159
144
"env": {
160
145
"HOLOVIZ_MCP_USER_DIR": "/path/to/custom/dir"
161
146
}
@@ -169,16 +154,19 @@ Use a custom directory for configuration and data:
169
154
After configuration, test with your AI assistant:
170
155
171
156
1.**Simple Query**:
157
+
172
158
```
173
159
List available Panel input components
174
160
```
175
161
176
162
2.**Detailed Query**:
163
+
177
164
```
178
165
What parameters does the Panel TextInput component have?
179
166
```
180
167
181
168
3.**Code Generation**:
169
+
182
170
```
183
171
Create a simple Panel dashboard with a slider
184
172
```
@@ -190,31 +178,36 @@ If you get detailed, accurate responses, your configuration is working! 🎉
190
178
### Server Not Starting
191
179
192
180
**Check the command**:
181
+
193
182
```bash
194
183
# Test the server directly
195
-
uvx holoviz-mcp
184
+
holoviz-mcp
196
185
```
197
186
198
187
**Verify uv installation**:
188
+
199
189
```bash
200
190
uv --version
201
191
```
202
192
203
193
**Check Python version**:
194
+
204
195
```bash
205
196
python --version # Should be 3.11 or higher
206
197
```
207
198
208
199
### AI Assistant Not Recognizing Components
209
200
210
201
1.**Verify documentation index exists**:
202
+
211
203
```bash
212
204
ls ~/.holoviz-mcp
213
205
```
214
206
215
207
2.**Recreate the index**:
208
+
216
209
```bash
217
-
uvx holoviz-mcp update index
210
+
holoviz-mcp update index
218
211
```
219
212
220
213
3.**Restart your IDE**
@@ -228,6 +221,7 @@ python --version # Should be 3.11 or higher
228
221
### Permission Errors
229
222
230
223
**Linux/macOS**: Ensure the configuration file is readable:
0 commit comments