From 518f8d70565eea29c0acedd7dd7054a40338ed8e Mon Sep 17 00:00:00 2001 From: Marc Skov Madsen Date: Tue, 20 Jan 2026 04:02:35 +0000 Subject: [PATCH 1/7] uv tool description update --- docs/explanation/architecture.md | 3 +- docs/explanation/security.md | 12 +++--- docs/how-to/configuration.md | 24 ++++++------ docs/how-to/ide-configuration.md | 62 ++++++++++++++----------------- docs/how-to/installation.md | 28 +++----------- docs/how-to/serve-apps.md | 6 ++- docs/how-to/troubleshooting.md | 52 +++++++++++++++++--------- docs/how-to/updates.md | 16 ++++---- docs/tutorials/copilot.md | 2 +- docs/tutorials/display-server.md | 4 -- docs/tutorials/getting-started.md | 39 +++++++++++-------- 11 files changed, 124 insertions(+), 124 deletions(-) diff --git a/docs/explanation/architecture.md b/docs/explanation/architecture.md index a49c46c..65b2004 100644 --- a/docs/explanation/architecture.md +++ b/docs/explanation/architecture.md @@ -112,9 +112,10 @@ MCP Server β†’ MCP Client β†’ AI Assistant (with app URL) ### Documentation Index -Location: `~/.holoviz-mcp/chroma/` +Location: `~/.holoviz-mcp/vector_db/` The documentation index uses ChromaDB to store: + - Document embeddings (vector representations) - Document metadata (source, project, path) - Original document text diff --git a/docs/explanation/security.md b/docs/explanation/security.md index adcf770..0cbc3e1 100644 --- a/docs/explanation/security.md +++ b/docs/explanation/security.md @@ -26,12 +26,12 @@ HoloViz MCP is designed with security in mind, but like any tool that provides A **Localhost Only** (Secure): ```bash -HOLOVIZ_MCP_HOST=127.0.0.1 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp +HOLOVIZ_MCP_HOST=127.0.0.1 HOLOVIZ_MCP_TRANSPORT=http holoviz-mcp ``` **All Interfaces** (Requires firewall): ```bash -HOLOVIZ_MCP_HOST=0.0.0.0 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp +HOLOVIZ_MCP_HOST=0.0.0.0 HOLOVIZ_MCP_TRANSPORT=http holoviz-mcp ``` ### Docker Deployments @@ -48,7 +48,7 @@ Docker images default to `0.0.0.0` for accessibility. Secure with: ### Documentation Indexing - **Data Flow**: GitHub β†’ Local Machine β†’ ChromaDB -- **Storage**: `~/.holoviz-mcp/chroma/` +- **Storage**: `~/.holoviz-mcp/vector_db/` - **External Services**: None (except GitHub for cloning) - **Privacy**: All processing is local @@ -64,7 +64,7 @@ Docker images default to `0.0.0.0` for accessibility. Secure with: By default, ChromaDB telemetry is disabled. If you enable it: ```bash -ANONYMIZED_TELEMETRY=true uvx holoviz-mcp +ANONYMIZED_TELEMETRY=true holoviz-mcp ``` Only anonymized usage statistics are sent to ChromaDB. @@ -83,7 +83,7 @@ HoloViz MCP can read: HoloViz MCP writes to: - Configuration directory (`~/.holoviz-mcp/`) -- Documentation index (`~/.holoviz-mcp/chroma/`) +- Documentation index (`~/.holoviz-mcp/vector_db/`) - Log files (if configured) - Server processes (if code execution enabled) @@ -217,7 +217,7 @@ Logs may contain: Set appropriately for your environment: ```bash -HOLOVIZ_MCP_LOG_LEVEL=WARNING uvx holoviz-mcp +HOLOVIZ_MCP_LOG_LEVEL=WARNING holoviz-mcp ``` ## Security Checklist diff --git a/docs/how-to/configuration.md b/docs/how-to/configuration.md index b4258a0..e9907ce 100644 --- a/docs/how-to/configuration.md +++ b/docs/how-to/configuration.md @@ -6,7 +6,7 @@ This guide explains how to customize HoloViz MCP behavior through configuration HoloViz MCP uses a YAML configuration file located at: -``` +```bash ~/.holoviz-mcp/config.yaml ``` @@ -40,7 +40,7 @@ Values: `stdio`, `http` Default: `stdio` ```bash -HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp +HOLOVIZ_MCP_TRANSPORT=http holoviz-mcp ``` **HOLOVIZ_MCP_HOST** @@ -48,7 +48,7 @@ Host address to bind to (HTTP transport only). Default: `127.0.0.1` ```bash -HOLOVIZ_MCP_HOST=0.0.0.0 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp +HOLOVIZ_MCP_HOST=0.0.0.0 HOLOVIZ_MCP_TRANSPORT=http holoviz-mcp ``` **HOLOVIZ_MCP_PORT** @@ -56,7 +56,7 @@ Port to bind to (HTTP transport only). Default: `8000` ```bash -HOLOVIZ_MCP_PORT=9000 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp +HOLOVIZ_MCP_PORT=9000 HOLOVIZ_MCP_TRANSPORT=http holoviz-mcp ``` **HOLOVIZ_MCP_LOG_LEVEL** @@ -65,7 +65,7 @@ Values: `DEBUG`, `INFO`, `WARNING`, `ERROR` Default: `INFO` ```bash -HOLOVIZ_MCP_LOG_LEVEL=DEBUG uvx holoviz-mcp +HOLOVIZ_MCP_LOG_LEVEL=DEBUG holoviz-mcp ``` **HOLOVIZ_MCP_SERVER_NAME** @@ -78,7 +78,7 @@ Default: `holoviz-mcp` URL prefix for Panel apps when running remotely. ```bash -JUPYTER_SERVER_PROXY_URL=/proxy/5007/ uvx holoviz-mcp +JUPYTER_SERVER_PROXY_URL=/proxy/5007/ holoviz-mcp ``` This is useful when running in JupyterHub or similar environments. @@ -91,7 +91,7 @@ Values: `true`, `false` Default: `false` ```bash -ANONYMIZED_TELEMETRY=true uvx holoviz-mcp +ANONYMIZED_TELEMETRY=true holoviz-mcp ``` ### Display Server Configuration @@ -192,7 +192,7 @@ docs: After adding repositories, update the index: ```bash -uvx holoviz-mcp update index +holoviz-mcp update index ``` ## IDE-Specific Configuration @@ -206,8 +206,7 @@ Set environment variables in `mcp.json`: "servers": { "holoviz": { "type": "stdio", - "command": "uvx", - "args": ["holoviz-mcp"], + "command": "holoviz-mcp", "env": { "HOLOVIZ_MCP_LOG_LEVEL": "DEBUG", } @@ -222,8 +221,7 @@ Set environment variables in `mcp.json`: { "mcpServers": { "holoviz": { - "command": "uvx", - "args": ["holoviz-mcp"], + "command": "holoviz-mcp", "env": { "HOLOVIZ_MCP_LOG_LEVEL": "INFO" } @@ -241,7 +239,7 @@ See the [Docker Guide](docker.md) for Docker-specific configuration options. HoloViz MCP includes a built-in configuration viewer. Run: ```bash -uvx holoviz-mcp serve +holoviz-mcp serve ``` Navigate to the Configuration Viewer tool to see your current configuration. diff --git a/docs/how-to/ide-configuration.md b/docs/how-to/ide-configuration.md index efe675c..8ca4090 100644 --- a/docs/how-to/ide-configuration.md +++ b/docs/how-to/ide-configuration.md @@ -4,31 +4,22 @@ This guide covers configuring HoloViz MCP with different IDEs and AI assistants. ## VS Code + GitHub Copilot -### Quick Install - -Click to install automatically: - -[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square)](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) - -### Manual Configuration - 1. Open VS Code 2. Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS) 3. Type "MCP: Edit Settings" and press Enter 4. Add this configuration to your `mcp.json`: -```json -{ - "servers": { - "holoviz": { - "type": "stdio", - "command": "uvx", - "args": ["holoviz-mcp"] - } - }, - "inputs": [] -} -``` + ```json + { + "servers": { + "holoviz": { + "type": "stdio", + "command": "holoviz-mcp" + } + }, + "inputs": [] + } + ``` 5. Save and restart VS Code @@ -61,8 +52,7 @@ Click to install automatically: { "mcpServers": { "holoviz": { - "command": "uvx", - "args": ["holoviz-mcp"] + "command": "holoviz-mcp", } } } @@ -90,8 +80,7 @@ After restarting Claude Desktop, look for the MCP indicator (πŸ”Œ) in the interf ```json { "name": "holoviz", - "command": "uvx", - "args": ["holoviz-mcp"] + "command": "holoviz-mcp" } ``` @@ -105,8 +94,7 @@ Add to your Windsurf MCP configuration: { "mcpServers": { "holoviz": { - "command": "uvx", - "args": ["holoviz-mcp"] + "command": "holoviz-mcp" } } } @@ -119,8 +107,7 @@ For other MCP-compatible clients, use the standard configuration: ```json { "name": "holoviz", - "command": "uvx", - "args": ["holoviz-mcp"] + "command": "holoviz-mcp" } ``` @@ -135,8 +122,7 @@ You can customize server behavior using environment variables: "servers": { "holoviz": { "type": "stdio", - "command": "uvx", - "args": ["holoviz-mcp"], + "command": "holoviz-mcp", "env": { "HOLOVIZ_MCP_LOG_LEVEL": "DEBUG" } @@ -154,8 +140,7 @@ Use a custom directory for configuration and data: "servers": { "holoviz": { "type": "stdio", - "command": "uvx", - "args": ["holoviz-mcp"], + "command": "holoviz-mcp", "env": { "HOLOVIZ_MCP_USER_DIR": "/path/to/custom/dir" } @@ -169,16 +154,19 @@ Use a custom directory for configuration and data: After configuration, test with your AI assistant: 1. **Simple Query**: + ``` List available Panel input components ``` 2. **Detailed Query**: + ``` What parameters does the Panel TextInput component have? ``` 3. **Code Generation**: + ``` Create a simple Panel dashboard with a slider ``` @@ -190,17 +178,20 @@ If you get detailed, accurate responses, your configuration is working! πŸŽ‰ ### Server Not Starting **Check the command**: + ```bash # Test the server directly -uvx holoviz-mcp +holoviz-mcp ``` **Verify uv installation**: + ```bash uv --version ``` **Check Python version**: + ```bash python --version # Should be 3.11 or higher ``` @@ -208,13 +199,15 @@ python --version # Should be 3.11 or higher ### AI Assistant Not Recognizing Components 1. **Verify documentation index exists**: + ```bash ls ~/.holoviz-mcp ``` 2. **Recreate the index**: + ```bash - uvx holoviz-mcp update index + holoviz-mcp update index ``` 3. **Restart your IDE** @@ -228,6 +221,7 @@ python --version # Should be 3.11 or higher ### Permission Errors **Linux/macOS**: Ensure the configuration file is readable: + ```bash chmod 644 ~/.config/Code/User/globalStorage/github.copilot/mcp.json ``` diff --git a/docs/how-to/installation.md b/docs/how-to/installation.md index ea10564..609bb06 100644 --- a/docs/how-to/installation.md +++ b/docs/how-to/installation.md @@ -20,7 +20,7 @@ powershell -c "irm https://astral.sh/uv/install.ps1 | iex" For other installation methods, see the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/). -### Install HoloViz MCP +### Install as a Tool Install HoloViz MCP as a uv tool: @@ -38,7 +38,7 @@ uv tool install holoviz-mcp --with altair --with polars ### Install Chromium ```bash -uvx holoviz-mcp install chromium +holoviz-mcp install chromium ``` ### Create Documentation Index @@ -46,7 +46,7 @@ uvx holoviz-mcp install chromium After installation, create the documentation index: ```bash -uvx holoviz-mcp update index +holoviz-mcp update index ``` **Note**: This process takes 5-10 minutes on first run. @@ -56,7 +56,7 @@ uvx holoviz-mcp update index Test that the server starts correctly: ```bash -uvx holoviz-mcp +holoviz-mcp ``` Press `Ctrl+C` to stop the server. @@ -69,11 +69,7 @@ You can also install HoloViz MCP using pip: pip install holoviz-mcp ``` -Then create the documentation index: - -```bash -holoviz-mcp update index -``` +The install chromeium and create the index as previously described. ## Install with conda/mamba @@ -89,11 +85,7 @@ Or with mamba: mamba install -c conda-forge holoviz-mcp ``` -Then create the documentation index: - -```bash -holoviz-mcp update index -``` +The install chromeium and create the index as previously described. ## Install from Source @@ -135,14 +127,6 @@ After updating the package, refresh the documentation: holoviz-mcp update index ``` -### Convenience Aliases - -Add to your `.bashrc` or `.zshrc`: - -```bash -alias holoviz-mcp="uvx holoviz-mcp" -``` - ## Uninstalling ### With uv diff --git a/docs/how-to/serve-apps.md b/docs/how-to/serve-apps.md index e43b914..ba08fb9 100644 --- a/docs/how-to/serve-apps.md +++ b/docs/how-to/serve-apps.md @@ -1,4 +1,4 @@ -# How‑To: Serve HoloViz MCP Panel apps locally for exploration, learning, and validation. +# How‑To: Serve HoloViz MCP Panel apps locally for exploration, learning, and validation ## Local Usage @@ -9,9 +9,11 @@ ### Steps 1. Start the local Panel server: + ```bash - uvx holoviz-mcp serve + holoviz-mcp serve ``` + 2. Open the URL printed in the terminal. This starts the bundled Panel apps. ## Online Demo diff --git a/docs/how-to/troubleshooting.md b/docs/how-to/troubleshooting.md index eaabd59..c250c63 100644 --- a/docs/how-to/troubleshooting.md +++ b/docs/how-to/troubleshooting.md @@ -48,18 +48,21 @@ Install a newer Python version if needed. **Solution**: 1. Test the server directly: + ```bash - uvx holoviz-mcp + holoviz-mcp ``` 2. Check for error messages in the output 3. Verify Python version: + ```bash python --version # Should be 3.11+ ``` 4. Reinstall HoloViz MCP: + ```bash uv tool uninstall holoviz-mcp uv tool install holoviz-mcp @@ -74,8 +77,9 @@ Install a newer Python version if needed. 1. Check logs (VS Code: Output β†’ MCP: holoviz) 2. Try running with debug logging: + ```bash - HOLOVIZ_MCP_LOG_LEVEL=DEBUG uvx holoviz-mcp + HOLOVIZ_MCP_LOG_LEVEL=DEBUG holoviz-mcp ``` 3. Report the issue on [GitHub](https://github.com/MarcSkovMadsen/holoviz-mcp/issues) with logs @@ -93,7 +97,7 @@ lsof -i :8000 Use a different port: ```bash -HOLOVIZ_MCP_PORT=8001 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp +HOLOVIZ_MCP_PORT=8001 HOLOVIZ_MCP_TRANSPORT=http holoviz-mcp ``` ## Documentation Issues @@ -105,13 +109,15 @@ HOLOVIZ_MCP_PORT=8001 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp **Solution**: 1. Verify documentation index exists: + ```bash ls ~/.holoviz-mcp ``` 2. Create or recreate the index: + ```bash - uvx holoviz-mcp update index + holoviz-mcp update index ``` 3. Wait for indexing to complete (5-10 minutes) @@ -119,6 +125,7 @@ HOLOVIZ_MCP_PORT=8001 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp 4. Restart your IDE 5. Test with a specific query: + ``` What parameters does Panel's TextInput component have? ``` @@ -132,14 +139,16 @@ HOLOVIZ_MCP_PORT=8001 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp 1. Check internet connection 2. Try again with debug logging: + ```bash - HOLOVIZ_MCP_LOG_LEVEL=DEBUG uvx holoviz-mcp update index + HOLOVIZ_MCP_LOG_LEVEL=DEBUG holoviz-mcp update index ``` 3. Clear existing data and retry: + ```bash - rm -rf ~/.holoviz-mcp/chroma - uvx holoviz-mcp update index + rm -rf ~/.holoviz-mcp/vector_db + holoviz-mcp update index ``` 4. Check GitHub API rate limits (wait an hour and retry) @@ -151,7 +160,7 @@ HOLOVIZ_MCP_PORT=8001 HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp **Solution**: Update the documentation index: ```bash -uvx holoviz-mcp update index +holoviz-mcp update index ``` ## IDE Integration Issues @@ -166,13 +175,13 @@ uvx holoviz-mcp update index - Command Palette β†’ "MCP: Edit Settings" 2. Check configuration syntax: + ```json { "servers": { "holoviz": { "type": "stdio", - "command": "uvx", - "args": ["holoviz-mcp"] + "command": "holoviz-mcp" } }, "inputs": [] @@ -210,6 +219,7 @@ uvx holoviz-mcp update index 2. Ensure uv and Python are installed in the remote environment 3. Consider using HTTP transport: + ```json { "servers": { @@ -222,8 +232,9 @@ uvx holoviz-mcp update index ``` Then start server in remote: + ```bash - HOLOVIZ_MCP_TRANSPORT=http uvx holoviz-mcp + HOLOVIZ_MCP_TRANSPORT=http holoviz-mcp ``` ## Docker Issues @@ -235,16 +246,19 @@ uvx holoviz-mcp update index **Solution**: 1. Check logs: + ```bash docker logs holoviz-mcp ``` 2. Verify port availability: + ```bash lsof -i :8000 ``` 3. Try with debug logging: + ```bash docker run -it --rm \ -e HOLOVIZ_MCP_LOG_LEVEL=DEBUG \ @@ -263,6 +277,7 @@ docker run -v ~/.holoviz-mcp:/root/.holoviz-mcp ... ``` Verify: + ```bash docker inspect holoviz-mcp | grep -A 10 Mounts ``` @@ -279,6 +294,7 @@ sudo chown -R $USER:$USER ~/.holoviz-mcp ``` Or run with specific user: + ```bash docker run --user $(id -u):$(id -g) ... ``` @@ -298,9 +314,10 @@ docker run --user $(id -u):$(id -g) ... 3. If consistently slow, check system resources 4. Consider recreating documentation index: + ```bash - rm -rf ~/.holoviz-mcp/chroma - uvx holoviz-mcp update index + rm -rf ~/.holoviz-mcp/vector_db + holoviz-mcp update index ``` ### High Memory Usage @@ -312,6 +329,7 @@ docker run --user $(id -u):$(id -g) ... 1. This is expected with large documentation indices 2. For Docker, set memory limits: + ```bash docker run --memory=2g ... ``` @@ -325,11 +343,13 @@ docker run --user $(id -u):$(id -g) ... **VS Code**: View β†’ Output β†’ MCP: holoviz **Command Line**: + ```bash -HOLOVIZ_MCP_LOG_LEVEL=DEBUG uvx holoviz-mcp +HOLOVIZ_MCP_LOG_LEVEL=DEBUG holoviz-mcp ``` **Docker**: + ```bash docker logs holoviz-mcp ``` @@ -340,12 +360,10 @@ If you can't resolve the issue: 1. Gather information: - Python version: `python --version` - - HoloViz MCP version: `uvx holoviz-mcp --version` + - HoloViz MCP version: `holoviz-mcp --version` - Operating system - Error messages and logs - 2. Report on [GitHub Issues](https://github.com/MarcSkovMadsen/holoviz-mcp/issues) - 3. Include: - Clear description of the problem - Steps to reproduce diff --git a/docs/how-to/updates.md b/docs/how-to/updates.md index 74586fd..2e338c1 100644 --- a/docs/how-to/updates.md +++ b/docs/how-to/updates.md @@ -29,7 +29,7 @@ conda update -c conda-forge holoviz-mcp After updating the package, refresh the documentation index: ```bash -uvx holoviz-mcp update +holoviz-mcp update ``` This ensures you have the latest documentation from HoloViz projects. @@ -39,7 +39,7 @@ This ensures you have the latest documentation from HoloViz projects. For convenience, update both the package and documentation: ```bash -uv tool update holoviz-mcp && uvx holoviz-mcp update index +uv tool update holoviz-mcp && holoviz-mcp update index ``` ## Update Docker Image @@ -82,7 +82,7 @@ docker run -it --rm \ ### Check Package Version ```bash -uvx holoviz-mcp --version +holoviz-mcp --version ``` Or with pip: @@ -129,8 +129,8 @@ Replace `0.1.0` with the desired version. If the documentation index gets corrupted: ```bash -rm -rf ~/.holoviz-mcp/chroma -uvx holoviz-mcp update index +rm -rf ~/.holoviz-mcp/vector_db +holoviz-mcp update index ``` ## Automatic Updates @@ -157,10 +157,10 @@ Remove unused data: ```bash # Remove documentation index -rm -rf ~/.holoviz-mcp/chroma +rm -rf ~/.holoviz-mcp/vector_db # Recreate -uvx holoviz-mcp update index +holoviz-mcp update index ``` ### Verify Installation @@ -169,7 +169,7 @@ After updates, verify everything works: ```bash # Test server starts -uvx holoviz-mcp +holoviz-mcp # Check in IDE # Ask your AI assistant about Panel components diff --git a/docs/tutorials/copilot.md b/docs/tutorials/copilot.md index 71ca09f..e14b1af 100644 --- a/docs/tutorials/copilot.md +++ b/docs/tutorials/copilot.md @@ -41,7 +41,7 @@ Repeat 1.+2. and verify that the `holoviz` mcp server is now running. - Run the following command: ```bash - uvx holoviz-mcp install copilot + holoviz-mcp install copilot ``` - Wait for the command to complete successfully. diff --git a/docs/tutorials/display-server.md b/docs/tutorials/display-server.md index 2ff634d..dca42c4 100644 --- a/docs/tutorials/display-server.md +++ b/docs/tutorials/display-server.md @@ -35,11 +35,7 @@ The Display Server is included with the `holoviz-mcp` package. Please [make sure Now that you have the server installed, let's start it: ```bash -# If holoviz-mcp installed as package display-server - -# If holoviz-mcp installed as uv tool -uvx --from holoviz-mcp display-server ``` You should see output like this: diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md index a92bb3d..a4f5f9d 100644 --- a/docs/tutorials/getting-started.md +++ b/docs/tutorials/getting-started.md @@ -26,20 +26,22 @@ This tutorial will guide you through installing and using HoloViz MCP for the fi Open your terminal and install HoloViz MCP as a uv tool: ```bash -uv tool install holoviz-mcp +uv tool install holoviz-mcp[pydata] ``` -This command installs HoloViz MCP, making it available for your AI assistant to reference. +This command installs HoloViz MCP globally, making it available for your AI assistant to reference. !!! tip "What's happening?" The uv tool manager creates an isolated environment for HoloViz MCP and installs all necessary dependencies. + The extra `pydata` dependencies are added to install a wide range of python data related packages. We will assume these are installed through out this guide. You can replace them with your favorite dependencies for your own work. + ## Step 2: Install Chromium Install [Chromium](https://playwright.dev/docs/browsers) to enable the holoviz-mcp server to take screenshots: ```bash -uvx holoviz-mcp install chromium +holoviz-mcp install chromium ``` **πŸ“¦ This downloads 300MB** as it downloads the Chromium and FFMPEG engines. @@ -49,12 +51,20 @@ uvx holoviz-mcp install chromium HoloViz MCP needs to index the HoloViz documentation to provide intelligent answers. Run: ```bash -uvx holoviz-mcp update index +holoviz-mcp update index ``` **⏱️ This takes 5-10 minutes** as it downloads and indexes documentation from Panel, hvPlot, and other HoloViz libraries. -## Step 4: Configure Your AI Assistant +## Step 4: Install the agents + +If using copilot install the *agents*: + +```bash +holoviz-mcp install copilot +``` + +## Step 5: Configure Your AI Assistant Choose your AI assistant and follow the appropriate configuration: @@ -63,19 +73,18 @@ Choose your AI assistant and follow the appropriate configuration: 1. In VS Code, open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) 2. Type "MCP: Add Server..." and press Enter 3. Choose "Command (stdio)" -4. Choose "uvx holoviz-mcp" as the "Command to run" +4. Choose "holoviz-mcp" as the "Command to run" 5. Enter "holoviz" as the "Server ID" 6. Choose "Global" -This will add the below configuration to you global `mcp.json` file. +This will add the below configuration to your *user* `mcp.json` file. ```json { "servers": { "holoviz": { "type": "stdio", - "command": "uvx", - "args": ["holoviz-mcp"] + "command": "holoviz-mcp" } }, "inputs": [] @@ -97,8 +106,7 @@ Please refer to the [VS Code | MCP Servers](https://code.visualstudio.com/docs/c { "mcpServers": { "holoviz": { - "command": "uvx", - "args": ["holoviz-mcp"] + "command": "holoviz-mcp" } } } @@ -115,14 +123,13 @@ Please refer to the [VS Code | MCP Servers](https://code.visualstudio.com/docs/c ```json { "name": "holoviz", - "command": "uvx", - "args": ["holoviz-mcp"] + "command": "holoviz-mcp" } ``` 4. Save and restart Cursor -## Step 5: Verify Installation +## Step 6: Verify Installation Let's verify that HoloViz MCP is working correctly! @@ -161,7 +168,7 @@ Open a chat with your AI assistant and try these questions: If your AI assistant provides detailed, accurate answers with specific Panel component information, congratulations! HoloViz MCP is working correctly! πŸŽ‰ -## Step 6: Build Your First Dashboard +## Step 7: Build Your First Dashboard Now that everything is set up, let's build a simple dashboard. @@ -215,7 +222,7 @@ Now that you have HoloViz MCP running, explore more: 1. Verify Python 3.11+ is installed: `python --version` 2. Check uv installation: `uv --version` -3. Try running the server directly: `uvx holoviz-mcp` +3. Try running the server directly: `holoviz-mcp` 4. Check the server logs in VS Code's Output panel For more help, see the [Troubleshooting Guide](../how-to/troubleshooting.md) or join the [HoloViz Discord](https://discord.gg/AXRHnJU6sP). From 2356b19cf699d3b1e98d8d22044769d251c90e63 Mon Sep 17 00:00:00 2001 From: Marc Skov Madsen Date: Tue, 20 Jan 2026 04:13:43 +0000 Subject: [PATCH 2/7] update display docs --- src/holoviz_mcp/holoviz_mcp/server.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/holoviz_mcp/holoviz_mcp/server.py b/src/holoviz_mcp/holoviz_mcp/server.py index 95c14fa..e130b66 100644 --- a/src/holoviz_mcp/holoviz_mcp/server.py +++ b/src/holoviz_mcp/holoviz_mcp/server.py @@ -271,17 +271,18 @@ async def search( max_results: int = 5, ctx: Context | None = None, ) -> list[Document]: - """Search HoloViz documentation using semantic similarity. + """Search the documentation using semantic similarity. Optimized for finding relevant documentation based on natural language queries. - DO use this tool to find answers to questions about HoloViz libraries, such as Panel and hvPlot. + DO use this tool to search the holoviz projects documentation and any additional user-defined + projects. Args: query (str): Search query using natural language. For example "How to style Material UI components?" or "interactive plotting with widgets" project (str, optional): Optional project filter. Defaults to None. - Options: "panel", "panel-material-ui", "hvplot", "param", "holoviews" + Examples: "panel", "panel-material-ui", "hvplot", "param", "holoviews" content (bool, optional): Whether to include full content. Defaults to True. Set to False to only return metadata for faster responses. max_results (int, optional): Maximum number of results to return. Defaults to 5. @@ -360,7 +361,7 @@ async def display( A short description of the visualization method : {"jupyter", "panel"}, default "jupyter" Execution mode: - - "jupyter": Execute code and display the last expression's result + - "jupyter": Execute code and display the last expression's result. The last expression must be dedented fully. DO use this for standard data visualizations like plots, dataframes, etc. that do not import and use Panel directly. - "panel": Execute code and and display Panel objects marked .servable() DO use this for code that imports and uses Panel to create dashboards, apps, and complex layouts. From 63982fee5f12d2ac9911e895223c5aa601dc8e63 Mon Sep 17 00:00:00 2001 From: Marc Skov Madsen Date: Tue, 20 Jan 2026 05:56:39 +0100 Subject: [PATCH 3/7] Update docs/how-to/ide-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/how-to/ide-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/ide-configuration.md b/docs/how-to/ide-configuration.md index 8ca4090..9de2fc1 100644 --- a/docs/how-to/ide-configuration.md +++ b/docs/how-to/ide-configuration.md @@ -52,7 +52,7 @@ This guide covers configuring HoloViz MCP with different IDEs and AI assistants. { "mcpServers": { "holoviz": { - "command": "holoviz-mcp", + "command": "holoviz-mcp" } } } From c4549c09c6966424a64a6b2f222f63b40109b346 Mon Sep 17 00:00:00 2001 From: Marc Skov Madsen Date: Tue, 20 Jan 2026 05:57:02 +0100 Subject: [PATCH 4/7] Update docs/how-to/configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/how-to/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/configuration.md b/docs/how-to/configuration.md index e9907ce..41c2987 100644 --- a/docs/how-to/configuration.md +++ b/docs/how-to/configuration.md @@ -208,7 +208,7 @@ Set environment variables in `mcp.json`: "type": "stdio", "command": "holoviz-mcp", "env": { - "HOLOVIZ_MCP_LOG_LEVEL": "DEBUG", + "HOLOVIZ_MCP_LOG_LEVEL": "DEBUG" } } } From 0cd451bd78ee851831aeee97723d8143c6f26159 Mon Sep 17 00:00:00 2001 From: Marc Skov Madsen Date: Tue, 20 Jan 2026 05:57:10 +0100 Subject: [PATCH 5/7] Update docs/tutorials/getting-started.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/tutorials/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md index a4f5f9d..cc25635 100644 --- a/docs/tutorials/getting-started.md +++ b/docs/tutorials/getting-started.md @@ -34,7 +34,7 @@ This command installs HoloViz MCP globally, making it available for your AI assi !!! tip "What's happening?" The uv tool manager creates an isolated environment for HoloViz MCP and installs all necessary dependencies. - The extra `pydata` dependencies are added to install a wide range of python data related packages. We will assume these are installed through out this guide. You can replace them with your favorite dependencies for your own work. + The extra `pydata` dependencies are added to install a wide range of python data related packages. We will assume these are installed throughout this guide. You can replace them with your favorite dependencies for your own work. ## Step 2: Install Chromium From 7abe6f6012033a0aa536a52800f766425c6a813d Mon Sep 17 00:00:00 2001 From: Marc Skov Madsen Date: Tue, 20 Jan 2026 05:57:18 +0100 Subject: [PATCH 6/7] Update docs/tutorials/getting-started.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/tutorials/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md index cc25635..62573da 100644 --- a/docs/tutorials/getting-started.md +++ b/docs/tutorials/getting-started.md @@ -54,7 +54,7 @@ HoloViz MCP needs to index the HoloViz documentation to provide intelligent answ holoviz-mcp update index ``` -**⏱️ This takes 5-10 minutes** as it downloads and indexes documentation from Panel, hvPlot, and other HoloViz libraries. +**⏱️ This will take 5-10 minutes** as it downloads and indexes documentation from Panel, hvPlot, and other HoloViz libraries. ## Step 4: Install the agents From 293da2113bd931901e89368e1ab813a963ebae32 Mon Sep 17 00:00:00 2001 From: Marc Skov Madsen Date: Tue, 20 Jan 2026 04:58:47 +0000 Subject: [PATCH 7/7] review feedback --- docs/how-to/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/how-to/installation.md b/docs/how-to/installation.md index 609bb06..8d546b2 100644 --- a/docs/how-to/installation.md +++ b/docs/how-to/installation.md @@ -69,7 +69,7 @@ You can also install HoloViz MCP using pip: pip install holoviz-mcp ``` -The install chromeium and create the index as previously described. +Then install Chromium and create the index as previously described. ## Install with conda/mamba @@ -85,7 +85,7 @@ Or with mamba: mamba install -c conda-forge holoviz-mcp ``` -The install chromeium and create the index as previously described. +Then install Chhromium and create the index as previously described. ## Install from Source