Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
275 changes: 275 additions & 0 deletions docs/tutorials/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,281 @@ directory is on your PATH, run `uv tool update-shell` and restart your terminal.
If the server is already registered, remove it first with
`claude mcp remove panel-live-server`.

=== "Windsurf"

```bash
pls install windsurf
```

That covers the Windsurf editor. If you run Cascade as a plugin inside another
IDE, it reads a different file, so point the command at it:

```bash
pls install windsurf --config-path ~/.codeium/mcp_config.json
```

To set it up by hand instead, add to `~/.codeium/windsurf/mcp_config.json`
(editor) or `~/.codeium/mcp_config.json` (plugin):

```json
{
"mcpServers": {
"panel-live-server": {
"command": "/path/to/pls",
"args": ["mcp"]
}
}
}
```

!!! warning "Use your absolute path"
Replace `"command": "/path/to/pls"` with the path printed by `which pls` above,
e.g. `"command": "/home/user/.local/bin/pls"`

Open the MCP servers panel (hammer icon) in Cascade and confirm it's running.

=== "Cline"

```bash
pls install cline
```

Cline stores this separately from `.vscode/mcp.json`, so running `pls install
vscode` does not configure Cline. One file serves every editor Cline runs in,
VS Code, Insiders, Cursor, and VSCodium alike.

To set it up by hand instead, add to
`~/.cline/data/settings/cline_mcp_settings.json`:

```json
{
"mcpServers": {
"panel-live-server": {
"command": "/path/to/pls",
"args": ["mcp"]
}
}
}
```

!!! warning "Use your absolute path"
Replace `"command": "/path/to/pls"` with the path printed by `which pls` above,
e.g. `"command": "/home/user/.local/bin/pls"`

Open Cline's MCP Servers panel and confirm panel-live-server is connected.

=== "JetBrains / Junie"

```bash
pls install jetbrains
```

This sets up **Junie**. JetBrains AI Assistant is a separate product with no
config file to write: add the server there from Settings → Tools → AI Assistant
→ Model Context Protocol, using the same `command` and `args` shown below.

To set Junie up by hand instead, add to `~/.junie/mcp/mcp.json`:

```json
{
"mcpServers": {
"panel-live-server": {
"command": "/path/to/pls",
"args": ["mcp"]
}
}
}
```

!!! warning "Use your absolute path"
Replace `"command": "/path/to/pls"` with the path printed by `which pls` above,
e.g. `"command": "/home/user/.local/bin/pls"`

Restart the IDE, or reopen Junie's MCP settings, for the change to take effect.

=== "Gemini CLI"

```bash
pls install gemini-cli
```

This writes into `~/.gemini/settings.json`, leaving every other setting there
(theme, auth, other servers) untouched. To set it up by hand instead, add:

```json
{
"mcpServers": {
"panel-live-server": {
"command": "/path/to/pls",
"args": ["mcp"]
}
}
}
```

!!! warning "Use your absolute path"
Replace `"command": "/path/to/pls"` with the path printed by `which pls` above,
e.g. `"command": "/home/user/.local/bin/pls"`

Restart the Gemini CLI for the change to take effect.

=== "Antigravity"

```bash
pls install antigravity
```

To set it up by hand instead, add to `~/.gemini/antigravity/mcp_config.json`:

```json
{
"mcpServers": {
"panel-live-server": {
"command": "/path/to/pls",
"args": ["mcp"]
}
}
}
```

!!! warning "Use your absolute path"
Replace `"command": "/path/to/pls"` with the path printed by `which pls` above,
e.g. `"command": "/home/user/.local/bin/pls"`

!!! note "Two possible locations"
Antigravity's own docs give this path as `~/.gemini/config/mcp_config.json`,
but the shipping build reads `~/.gemini/antigravity/mcp_config.json`. The
command writes whichever one your install already uses, so prefer it over
editing by hand if you are unsure.

Open Manage MCP Servers in Antigravity and confirm it's connected.

=== "Kiro"

```bash
pls install kiro
```

To set it up by hand instead, add to `~/.kiro/settings/mcp.json`:

```json
{
"mcpServers": {
"panel-live-server": {
"command": "/path/to/pls",
"args": ["mcp"]
}
}
}
```

!!! warning "Use your absolute path"
Replace `"command": "/path/to/pls"` with the path printed by `which pls` above,
e.g. `"command": "/home/user/.local/bin/pls"`

Reload Kiro, or open the MCP panel, for the change to take effect.

=== "Copilot CLI"

```bash
pls install copilot
```

This is the standalone `copilot` CLI, not VS Code's Copilot Chat (which already
reads `.vscode/mcp.json`, see the VS Code tab). To set it up by hand instead, add
to `~/.copilot/mcp-config.json`:

```json
{
"mcpServers": {
"panel-live-server": {
"type": "local",
"command": "/path/to/pls",
"args": ["mcp"],
"tools": ["*"]
}
}
}
```

!!! warning "Use your absolute path"
Replace `"command": "/path/to/pls"` with the path printed by `which pls` above,
e.g. `"command": "/home/user/.local/bin/pls"`

Run `/mcp show` in the Copilot CLI to confirm panel-live-server is connected.

=== "Kilo Code"

```bash
pls install kilo-code
```

Kilo Code packs the command and its arguments into one array under a `mcp` key,
rather than separate `command`/`args` fields under `mcpServers`. To set it up by
hand instead, add to `~/.config/kilo/kilo.jsonc`:

```json
{
"mcp": {
"panel-live-server": {
"type": "local",
"command": ["/path/to/pls", "mcp"],
"enabled": true
}
}
}
```

!!! warning "Use your absolute path"
Replace `/path/to/pls` with the path printed by `which pls` above,
e.g. `"command": ["/home/user/.local/bin/pls", "mcp"]`

Reload the window for the change to take effect.

=== "Codex CLI"

```bash
pls install codex
```

Codex uses TOML, not JSON. To set it up by hand instead, add to `~/.codex/config.toml`:

```toml
[mcp_servers.panel-live-server]
command = "/path/to/pls"
args = ["mcp"]
```

!!! warning "Use your absolute path"
Replace `/path/to/pls` with the path printed by `which pls` above,
e.g. `command = "/home/user/.local/bin/pls"`

Restart the Codex CLI for the change to take effect.

=== "Mistral Vibe"

```bash
pls install mistral-vibe
```

Vibe also uses TOML, and lists servers as an array of tables identified by a
`name` field rather than keyed by their own table name. To set it up by hand
instead, add to `~/.vibe/config.toml`:

```toml
[[mcp_servers]]
name = "panel-live-server"
transport = "stdio"
command = "/path/to/pls"
args = ["mcp"]
```

!!! warning "Use your absolute path"
Replace `/path/to/pls` with the path printed by `which pls` above,
e.g. `command = "/home/user/.local/bin/pls"`

Restart Vibe for the change to take effect.

=== "claude.ai"

claude.ai requires HTTP transport and a public URL. You can use any tunneling service
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/mcp-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ asked an AI to produce a chart and seen it rendered live in your IDE.
## Step 1: Add Panel Live Server to your MCP configuration

See [Installation → Connect to your MCP client](installation.md#connect-to-your-mcp-client) for
the full setup instructions for VS Code, Cursor, Claude Desktop, Claude Code, and claude.ai.
the full setup instructions for VS Code, Cursor, Claude Desktop, Claude Code, claude.ai, and more.

!!! note
When the MCP server starts, it automatically starts the Panel server in the background.
Expand Down
Loading
Loading