Skip to content
VS Code

n8n-guard for VS Code

io.github.flow-84/n8n-guard

Read-only health checks for self-hosted n8n: datastore growth, stuck runs, retention, git drift.

client:VS Code transport:stdio runtime:npm

Install n8n-guard in VS Code

.vscode/mcp.json

{
  "inputs": [
    {
      "type": "promptString",
      "id": "n8n-url",
      "description": "N8N_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "n8n-api-key",
      "description": "N8N_API_KEY",
      "password": true
    },
    {
      "type": "promptString",
      "id": "n8n-sqlite-path",
      "description": "N8N_SQLITE_PATH",
      "password": true
    },
    {
      "type": "promptString",
      "id": "n8n-postgres-url",
      "description": "N8N_POSTGRES_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "n8n-git-repo-path",
      "description": "N8N_GIT_REPO_PATH",
      "password": true
    },
    {
      "type": "promptString",
      "id": "n8n-guard-stuck-minutes",
      "description": "N8N_GUARD_STUCK_MINUTES",
      "password": true
    },
    {
      "type": "promptString",
      "id": "n8n-guard-db-warn-bytes",
      "description": "N8N_GUARD_DB_WARN_BYTES",
      "password": true
    },
    {
      "type": "promptString",
      "id": "n8n-guard-db-critical-bytes",
      "description": "N8N_GUARD_DB_CRITICAL_BYTES",
      "password": true
    },
    {
      "type": "promptString",
      "id": "n8n-guard-timeout-ms",
      "description": "N8N_GUARD_TIMEOUT_MS",
      "password": true
    }
  ],
  "servers": {
    "n8n-guard": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "n8n-guard"
      ],
      "env": {
        "N8N_URL": "${input:n8n-url}",
        "N8N_API_KEY": "${input:n8n-api-key}",
        "N8N_SQLITE_PATH": "${input:n8n-sqlite-path}",
        "N8N_POSTGRES_URL": "${input:n8n-postgres-url}",
        "N8N_GIT_REPO_PATH": "${input:n8n-git-repo-path}",
        "N8N_GUARD_STUCK_MINUTES": "${input:n8n-guard-stuck-minutes}",
        "N8N_GUARD_DB_WARN_BYTES": "${input:n8n-guard-db-warn-bytes}",
        "N8N_GUARD_DB_CRITICAL_BYTES": "${input:n8n-guard-db-critical-bytes}",
        "N8N_GUARD_TIMEOUT_MS": "${input:n8n-guard-timeout-ms}"
      }
    }
  }
}

VS Code prompts for each input the first time the server starts, so no secret is written to the file. VS Code docs

n8n-guard in other clients