VisualQ

Quick start for agents

Connect VisualQ MCP to Cursor or Claude Code in 5 minutes — org key, install, verify, first PR gate.

Get VisualQ working in your IDE agent in under 5 minutes. No dashboard clicking required after setup.

1. Create an org agent key

  1. Sign in at visualq.ai
  2. Open Settings → Agent API Keys (org admin)
  3. Click New agent key
    • Scope: mcp_full (read + write)
    • Optional: set a default project slug if you mainly work on one site
  4. Copy the key (vq_org_live_…) — shown once

Full wizard: Agent API Keys → Install guide

2. Install MCP (pick one path)

Fastest — setup CLI

npx @visualq/setup-agent cursor --key vq_org_live_YOUR_KEY --project my-site
TargetCommand
Cursor (user)… cursor --key …
Claude Code… claude --key …
Project repo… manual --key …

Optional: --profile vrt-qa|frt-qa|tracking-qa|full

  1. Create a key (step 1)
  2. Click Open in Cursor in the key dialog
  3. Paste your agent key when prompted
  4. Restart Cursor

Manual mcp.json

Add to ~/.cursor/mcp.json or .cursor/mcp.json:

{
  "mcpServers": {
    "visualq": {
      "command": "npx",
      "args": ["-y", "@visualq/mcp"],
      "env": {
        "VISUALQ_API_KEY": "vq_org_live_YOUR_KEY",
        "VISUALQ_BASE_URL": "https://visualq.ai",
        "VISUALQ_TOOL_PROFILE": "vrt-qa"
      }
    }
  }
}

No Node.js? Use hosted mode:

{
  "mcpServers": {
    "visualq": {
      "url": "https://visualq.ai/api/mcp",
      "headers": { "X-API-Key": "vq_org_live_YOUR_KEY" }
    }
  }
}

Restart your IDE after any install path.

3. Verify the connection

In Agent mode (not Ask-only), send:

List VisualQ scenarios for project my-site and run check_setup_health.

You should see MCP tool calls and structured JSON — not “I don't have access”.

You say…Expected
check_setup_health for my-siteSetup blockers list
get_site_health for my-siteRolling score + coverage
list_scenariosVRT scenario labels

4. Run your first PR gate

Use the MCP prompt pr-quality-gate, or say:

Run prompt pr-quality-gate for project my-site on staging.

The agent calls gate_pr_quality and returns blockMerge: true/false with rolling health context. Open viewerUrl in the response to inspect diffs in the dashboard.

5. Next steps

Troubleshooting

SymptomFix
MCP server red / missingNode 18+? Restart IDE. Key prefix must be vq_org_live_.
project_resolution_errorPass "project": "slug" or set default project on the key.
confirm_requiredMutating tools need confirm: true — say “yes, confirm”.
403 plan_gateUpgrade to Hobby+ for write tools.
Too many toolsSet VISUALQ_TOOL_PROFILE=vrt-qa.

On this page