# Visual Sentinel MCP server

> Allows AI assistants to monitor website health, perform DNS and SSL checks, and manage visual regression and uptime monitors.

- Repository: https://github.com/VisualSentinel/mcp-server
- Page: https://hostedmcp.org/servers/visualsentinel/mcp-server
- Transport: stdio, remote
- Stars: 1
- License: MIT
- Latest version: 0.2.3

## Install

### Claude Code

```sh
claude mcp add --env 'VS_API_KEY=<YOUR_VS_API_KEY>' mcp-server -- npx -y @visualsentinel/mcp-server
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@visualsentinel/mcp-server"
      ],
      "env": {
        "VS_API_KEY": "<YOUR_VS_API_KEY>"
      }
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@visualsentinel/mcp-server"
      ],
      "env": {
        "VS_API_KEY": "<YOUR_VS_API_KEY>"
      }
    }
  }
}
```

### VS Code CLI

```sh
code --add-mcp '{"name":"mcp-server","type":"stdio","command":"npx","args":["-y","@visualsentinel/mcp-server"],"env":{"VS_API_KEY":"<YOUR_VS_API_KEY>"}}'
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@visualsentinel/mcp-server"
      ],
      "env": {
        "VS_API_KEY": "<YOUR_VS_API_KEY>"
      }
    }
  }
}
```

### Codex

```sh
codex mcp add mcp-server --env 'VS_API_KEY=<YOUR_VS_API_KEY>' -- npx -y @visualsentinel/mcp-server
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.mcp-server]
command = "npx"
args = ["-y", "@visualsentinel/mcp-server"]

[mcp_servers.mcp-server.env]
VS_API_KEY = "<YOUR_VS_API_KEY>"
```

### Gemini CLI

```sh
gemini mcp add -s user -e 'VS_API_KEY=<YOUR_VS_API_KEY>' mcp-server npx -- -y @visualsentinel/mcp-server
```

### Gemini settings.json (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@visualsentinel/mcp-server"
      ],
      "env": {
        "VS_API_KEY": "<YOUR_VS_API_KEY>"
      }
    }
  }
}
```

## Environment variables

| Name | Required | Secret | Description |
|---|---|---|---|
| `VS_API_KEY` | no | yes | Visual Sentinel API key for the twelve account tools (every paid plan, including the 10-day free trial). Create one at https://visualsentinel.com/settings/api-keys. The five public tools work without it. |

## FAQ

### Do I need an account to use the server?

No, you can run DNS, SSL, and speed checks on any site without an account using the public tools.

### What tools require an API key?

Authenticated tools like creating monitors, listing incidents, and acknowledging alerts require a VS_API_KEY, which is available on every paid plan and the 10-day free trial.

### Is my API key secure?

Yes, your API key never leaves the machine running the MCP server; requests are sent directly to the service over HTTPS.
