Skip to content

Configure HoloViz MCP for Windsurf

This guide shows you how to configure HoloViz MCP with Windsurf IDE.

Prerequisites

Locate Your Configuration File

Find your Windsurf MCP configuration file. The location varies by operating system and Windsurf version. Common locations include:

  • macOS: ~/Library/Application Support/Windsurf/config.json or similar
  • Windows: %APPDATA%\Windsurf\config.json or similar
  • Linux: ~/.config/Windsurf/config.json or similar

Note

The exact configuration file location may vary. Check Windsurf's documentation for your specific version.

Add the MCP Server

  1. Open the Windsurf MCP configuration file in a text editor
  2. Add this configuration:
{
  "mcpServers": {
    "holoviz": {
      "command": "holoviz-mcp"
    }
  }
}
  1. Save the file
  2. Restart Windsurf

Existing Configuration

If your file already has other MCP servers configured, add "holoviz" to the existing mcpServers object:

{
  "mcpServers": {
    "existing-server": {
      "command": "existing-command"
    },
    "holoviz": {
      "command": "holoviz-mcp"
    }
  }
}

Test Your Configuration

Test the configuration with Windsurf's AI:

  1. Simple Query - Open Windsurf's AI assistant and ask:
List available Panel input components
  1. Detailed Query - Ask for specific information:
What parameters does the Panel TextInput component have?
  1. Code Generation - Ask Windsurf AI to generate code:
Create a simple Panel dashboard with a slider

If Windsurf's AI provides detailed, accurate responses with specific Panel component information, your configuration is working! 🎉

Advanced Configuration

Set Log Level

For debugging, increase the log level:

{
  "mcpServers": {
    "holoviz": {
      "command": "holoviz-mcp",
      "env": {
        "HOLOVIZ_MCP_LOG_LEVEL": "DEBUG"
      }
    }
  }
}

Custom Configuration Directory

Use a custom directory for configuration and data:

{
  "mcpServers": {
    "holoviz": {
      "command": "holoviz-mcp",
      "env": {
        "HOLOVIZ_MCP_USER_DIR": "/path/to/custom/dir"
      }
    }
  }
}

Troubleshooting

Configuration File Not Found

Check Windsurf's documentation for the correct configuration file location for your version.

Create the file if it doesn't exist, using the configuration above.

Server Not Starting

Check that holoviz-mcp is installed:

holoviz-mcp --version

Test the server directly:

holoviz-mcp

Press Ctrl+C to stop it.

Windsurf AI Not Recognizing Components

  1. Verify documentation index exists:
ls ~/.holoviz-mcp
  1. Recreate the index:
holoviz-mcp update index
  1. Restart Windsurf

Configuration Not Loading

Verify JSON syntax - ensure there are no trailing commas, missing quotes, or other syntax errors.

Restart Windsurf completely - quit and reopen the application.

Check logs - look for error messages in Windsurf's output or logs.

Permission Errors

Linux/macOS: Ensure the configuration file is readable:

chmod 644 ~/.config/Windsurf/config.json  # Adjust path as needed

Next Steps