Platform connections

Dashboard sync

Use the same API key everywhere so scans, ship checks, and MCP runs appear under Runs and Findings. Nothing here stores secrets — copy snippets into your own env or CI secrets.

Create or rotate an API key

Local & CLI

Export env vars, run scan --sync or ship --sync.

shell

export GUARDRAIL_API_URL=https://api.guardrailai.dev
export GUARDRAIL_API_KEY=grl_...
export GUARDRAIL_SYNC=1

GitHub Actions

Add repository secrets GUARDRAIL_API_KEY and optional GUARDRAIL_API_URL.

Generated workflows from guardrail init can include a “Sync to Guardrail Cloud” step. In CI, the API URL defaults to https://api.guardrailai.dev when CI=true and only the key is set.

VS Code / Cursor

Point the extension at your API and enable upload after Ship Check.

settings.json

{
  "guardrail.apiEndpoint": "https://api.guardrailai.dev",
  "guardrail.uploadRunsToCloud": true
}

MCP hosts

Pass the same env vars into MCP server config (Claude Desktop, Cursor, etc.).

env

GUARDRAIL_API_URL=https://api.guardrailai.dev
GUARDRAIL_API_KEY=grl_...
# Optional: GUARDRAIL_SYNC=0 to disable MCP→cloud upload