Skip to content

Commit b1a3455

Browse files
Merge pull request #88 from MarcSkovMadsen/enhancement/holoviews_mcp_server
Simplify getting started
2 parents 0556958 + 38eef39 commit b1a3455

8 files changed

Lines changed: 72 additions & 172 deletions

File tree

README.md

Lines changed: 0 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -33,102 +33,6 @@ A comprehensive [Model Context Protocol](https://modelcontextprotocol.io/introdu
3333
- **📖 Always Updated**: Documentation stays current with the latest HoloViz ecosystem changes.
3434
- **🔧 Zero Setup**: Works immediately with any MCP-compatible AI assistant.
3535

36-
## 🚀 Quick Start
37-
38-
### Requirements
39-
40-
- Python 3.11+ and [uv](https://docs.astral.sh/uv/)
41-
- VS Code with GitHub Copilot, Claude Desktop, Cursor, or any other MCP-compatible client
42-
43-
### Installation
44-
45-
Install HoloViz MCP as a [uv tool](https://docs.astral.sh/uv/concepts/tools/):
46-
47-
```bash
48-
uv tool install holoviz-mcp[panel-extensions]
49-
```
50-
51-
Create the documentation index (takes up to 10 minutes on first run):
52-
53-
```bash
54-
uvx holoviz-mcp update index
55-
```
56-
57-
If you are using Github Copilot run
58-
59-
```bash
60-
uvx holoviz-mcp update copilot
61-
```
62-
63-
### Configure Your IDE
64-
65-
**VS Code + GitHub Copilot**: Add this configuration to your `mcp.json`:
66-
67-
```json
68-
{
69-
"servers": {
70-
"holoviz": {
71-
"type": "stdio",
72-
"command": "uvx",
73-
"args": ["holoviz-mcp"]
74-
}
75-
},
76-
"inputs": []
77-
}
78-
```
79-
80-
**Claude Desktop**: Add to your configuration file (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
81-
82-
```json
83-
{
84-
"mcpServers": {
85-
"holoviz": {
86-
"command": "uvx",
87-
"args": ["holoviz-mcp"]
88-
}
89-
}
90-
}
91-
```
92-
93-
**Cursor**: Go to `Cursor Settings``Features``Model Context Protocol``Add Server`:
94-
95-
```json
96-
{
97-
"name": "holoviz",
98-
"command": "uvx",
99-
"args": ["holoviz-mcp"]
100-
}
101-
```
102-
103-
Restart your IDE and start asking about HoloViz documentation and Panel components!
104-
105-
### Using Docker
106-
107-
For containerized deployment:
108-
109-
```bash
110-
# Pull the latest image
111-
docker pull ghcr.io/marcskovmadsen/holoviz-mcp:latest
112-
113-
# Run with HTTP transport
114-
docker run -it --rm \
115-
-p 8000:8000 \
116-
-e HOLOVIZ_MCP_TRANSPORT=http \
117-
-v ~/.holoviz-mcp:/root/.holoviz-mcp \
118-
ghcr.io/marcskovmadsen/holoviz-mcp:latest
119-
```
120-
121-
See the [Docker Guide](https://marcskovmadsen.github.io/holoviz-mcp/how-to/docker/) for more details.
122-
123-
## 💡 Example Usage
124-
125-
Ask your AI assistant questions like:
126-
127-
- *"What Panel components are available for user input?"*
128-
- *"Show me how to create a dashboard with Panel Material UI components"*
129-
- *"What parameters does the Button component accept?"*
130-
- *"How do I deploy a Panel application?"*
131-
13236
Watch the [HoloViz MCP Introduction](https://youtu.be/M-YUZWEeSDA) on YouTube to see it in action.
13337

13438
[![HoloViz MCP Introduction](docs/assets/images/holoviz-mcp-introduction.png)](https://youtu.be/M-YUZWEeSDA)

docs/explanation/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ HoloViz MCP depends on:
189189
### Update Command
190190

191191
```bash
192-
uv tool update holoviz-mcp[panel-extensions]
192+
uv tool update holoviz-mcp
193193
```
194194

195195
## Logging & Monitoring

docs/how-to/installation.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,14 @@ For other installation methods, see the [uv installation guide](https://docs.ast
2525
Install HoloViz MCP as a uv tool:
2626

2727
```bash
28-
uv tool install holoviz-mcp[panel-extensions]
28+
uv tool install holoviz-mcp
2929
```
3030

31-
This installs HoloViz MCP with Panel extensions like Material UI, Graphic Walker, and others.
31+
### Install Chromium
3232

33-
!!! tip
34-
If you want to be able to use the `panel_take_screenshot` tool, you will need to install [playwright](https://playwright.dev/python/) and chromium
35-
```bash
36-
uv tool install holoviz-mcp[panel-extensions,playwright]
37-
uvx --from holoviz-mcp playwright install chromium
38-
```
33+
```bash
34+
uvx holoviz-mcp install chromium
35+
```
3936

4037
### Create Documentation Index
4138

@@ -62,7 +59,7 @@ Press `Ctrl+C` to stop the server.
6259
You can also install HoloViz MCP using pip:
6360

6461
```bash
65-
pip install holoviz-mcp[panel-extensions]
62+
pip install holoviz-mcp
6663
```
6764

6865
Then create the documentation index:
@@ -101,24 +98,6 @@ cd holoviz-mcp
10198
pip install -e .[dev]
10299
```
103100

104-
## Optional Dependencies
105-
106-
### Panel Extensions
107-
108-
Install with common Panel extensions:
109-
110-
```bash
111-
uv tool install holoviz-mcp[panel-extensions]
112-
```
113-
114-
This includes:
115-
- `panel-material-ui`: Material Design components
116-
- `panel-graphic-walker`: Interactive data visualization
117-
- `panel-full-calendar`: Calendar components
118-
- `panel-neuroglancer`: Neuroglancer integration
119-
- `panel-precision-slider`: High-precision sliders
120-
- `panel-web-llm`: WebLLM integration
121-
122101
### Development Dependencies
123102

124103
For development work:
@@ -138,7 +117,7 @@ For containerized deployment, see the [Docker Guide](docker.md).
138117
### Update with uv
139118

140119
```bash
141-
uv tool update holoviz-mcp[panel-extensions]
120+
uv tool update holoviz-mcp
142121
```
143122

144123
### Update Documentation Index

docs/how-to/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Install a newer Python version if needed.
6262
4. Reinstall HoloViz MCP:
6363
```bash
6464
uv tool uninstall holoviz-mcp
65-
uv tool install holoviz-mcp[panel-extensions]
65+
uv tool install holoviz-mcp
6666
```
6767

6868
### Server Crashes

docs/how-to/updates.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Keep HoloViz MCP up to date to ensure you have the latest features, bug fixes, a
99
Update the HoloViz MCP package:
1010

1111
```bash
12-
uv tool update holoviz-mcp[panel-extensions]
12+
uv tool update holoviz-mcp
1313
```
1414

1515
### With pip
1616

1717
```bash
18-
pip install --upgrade holoviz-mcp[panel-extensions]
18+
pip install --upgrade holoviz-mcp
1919
```
2020

2121
### With conda/mamba
@@ -39,7 +39,7 @@ This ensures you have the latest documentation from HoloViz projects.
3939
For convenience, update both the package and documentation:
4040

4141
```bash
42-
uv tool update holoviz-mcp[panel-extensions] && uvx holoviz-mcp update index
42+
uv tool update holoviz-mcp && uvx holoviz-mcp update index
4343
```
4444

4545
## Update Docker Image
@@ -119,7 +119,7 @@ Update when:
119119
If an update causes issues, rollback to a previous version:
120120

121121
```bash
122-
uv tool install holoviz-mcp[panel-extensions]==0.1.0
122+
uv tool install holoviz-mcp==0.1.0
123123
```
124124

125125
Replace `0.1.0` with the desired version.

docs/tutorials/getting-started.md

Lines changed: 38 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,55 @@
22

33
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!
44

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
17-
- **[uv](https://docs.astral.sh/uv/)** package installer
18-
- An **MCP-compatible AI assistant**:
19-
- VS Code with GitHub Copilot extension
20-
- Claude Desktop application
21-
- Cursor IDE
22-
- Or any other MCP-compatible client
5+
!!! tip "What you'll learn"
6+
- How to install HoloViz MCP
7+
- How to configure it with your AI assistant (VS Code, Claude Desktop, or Cursor)
8+
- How to use it to get help building Panel applications
9+
- How to verify everything is working correctly
10+
11+
!!! Prerequisites
12+
Before you begin, ensure you have:
13+
14+
- **Python 3.11 or newer** installed on your system
15+
- **[uv](https://docs.astral.sh/uv/)** package installer
16+
- An **MCP-compatible AI assistant**:
17+
- VS Code with GitHub Copilot extension
18+
- Claude Desktop application
19+
- Cursor IDE
20+
- Or any other MCP-compatible client
2321

2422
## Step 1: Install HoloViz MCP
2523

2624
Open your terminal and install HoloViz MCP as a uv tool:
2725

2826
```bash
29-
uv tool install holoviz-mcp[panel-extensions]
27+
uv tool install holoviz-mcp
3028
```
3129

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.
3334

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
3536

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
3744

3845
HoloViz MCP needs to index the HoloViz documentation to provide intelligent answers. Run:
3946

4047
```bash
4148
uvx holoviz-mcp update index
4249
```
4350

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.
4752

48-
## Step 3: Configure Your AI Assistant
53+
## Step 4: Configure Your AI Assistant
4954

5055
Choose your AI assistant and follow the appropriate configuration:
5156

@@ -54,7 +59,7 @@ Choose your AI assistant and follow the appropriate configuration:
5459
1. In VS Code, open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
5560
2. Type "MCP: Add Server..." and press Enter
5661
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"
5863
5. Enter "holoviz" as the "Server ID"
5964
6. Choose "Global"
6065

@@ -66,7 +71,7 @@ This will add the below configuration to you global `mcp.json` file.
6671
"holoviz": {
6772
"type": "stdio",
6873
"command": "uvx",
69-
"args": ["holoviz-mcp[panel-extensions]"]
74+
"args": ["holoviz-mcp"]
7075
}
7176
},
7277
"inputs": []
@@ -89,7 +94,7 @@ Please refer to the [VS Code | MCP Servers](https://code.visualstudio.com/docs/c
8994
"mcpServers": {
9095
"holoviz": {
9196
"command": "uvx",
92-
"args": ["holoviz-mcp[panel-extensions]"]
97+
"args": ["holoviz-mcp"]
9398
}
9499
}
95100
}
@@ -107,13 +112,13 @@ Please refer to the [VS Code | MCP Servers](https://code.visualstudio.com/docs/c
107112
{
108113
"name": "holoviz",
109114
"command": "uvx",
110-
"args": ["holoviz-mcp[panel-extensions]"]
115+
"args": ["holoviz-mcp"]
111116
}
112117
```
113118

114119
4. Save and restart Cursor
115120

116-
## Step 4: Verify Installation
121+
## Step 5: Verify Installation
117122

118123
Let's verify that HoloViz MCP is working correctly!
119124

@@ -152,7 +157,7 @@ Open a chat with your AI assistant and try these questions:
152157

153158
If your AI assistant provides detailed, accurate answers with specific Panel component information, congratulations! HoloViz MCP is working correctly! 🎉
154159

155-
## Step 5: Build Your First Dashboard
160+
## Step 6: Build Your First Dashboard
156161

157162
Now that everything is set up, let's build a simple dashboard:
158163

@@ -215,6 +220,7 @@ In this tutorial, you:
215220

216221
✅ Installed HoloViz MCP using uv
217222
✅ Created the documentation index
223+
✅ Installed Chromium
218224
✅ Configured your AI assistant
219225
✅ Verified the installation
220226
✅ Built your first Panel dashboard

pyproject.toml

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,14 @@ dependencies = [
4747
"matplotlib",
4848
"nbconvert",
4949
"packaging",
50+
"panel-full-calendar",
51+
"panel-graphic-walker",
5052
"panel-material-ui",
53+
"panel-neuroglancer",
54+
"panel-precision-slider",
55+
"panel-web-llm",
5156
"panel",
57+
"playwright",
5258
"plotly",
5359
"pydantic>=2.0",
5460
"PyYAML",
@@ -79,16 +85,6 @@ mypy = [
7985
"types-requests",
8086
"typing-extensions",
8187
]
82-
panel-extensions =[
83-
"panel-full-calendar",
84-
"panel-graphic-walker",
85-
"panel-neuroglancer",
86-
"panel-precision-slider",
87-
"panel-web-llm",
88-
]
89-
playwright = [
90-
"playwright",
91-
]
9288
[tool.ruff]
9389
exclude = [
9490
".git",

0 commit comments

Comments
 (0)