Skip to content

abecms/visualq-mcp

Repository files navigation

@visualq/mcp

MCP server for VisualQ — run VRT, poll results, and read structured failure reports from Cursor, Claude Desktop, or any MCP client.

Quick start (Cursor)

Add to .cursor/mcp.json or global MCP settings:

{
  "mcpServers": {
    "visualq": {
      "command": "npx",
      "args": ["-y", "@visualq/mcp"],
      "env": {
        "VISUALQ_API_KEY": "vq_live_…",
        "VISUALQ_BASE_URL": "https://visualq.ai"
      }
    }
  }
}

Create an API key in VisualQ: Project → Settings → API keys (prefix vq_live_).

Tools

Phase 1: list_projects, list_scenarios, run_vrt, run_baseline, get_run_status, wait_for_run, get_run_failures, get_diff_stats, get_quality_score

Phase 2: get_run_history, get_scenario_details, compare_runs, check_setup_health, explain_vrt_failure, perf_get_latest_report, seo_get_report, a11y_get_report, tracking_get_plan, tracking_get_audit_report, tracking_export_audit_report

Phase 3 (write — confirm: true required): approve_vrt_results, create_scenario, create_comparison_rule, run_frt_feature, post_pr_comment

API key scopes

Scope MCP read MCP write CI runs
ci no no yes
mcp_read yes no no
mcp_full yes yes yes

Existing keys without a scope default to mcp_full. Create scoped keys in Project → Settings → API Keys (optional scope field in API).

Streamable HTTP (optional)

VISUALQ_API_KEY=vq_live_… npx -y @visualq/mcp --http
# → http://127.0.0.1:3847/mcp

Development

npm install
npm run build
VISUALQ_API_KEY=vq_live_… node dist/index.js

Sync tool manifest from the visualq backend repo:

cd ../visualq && npm run mcp:export-manifest

Repository

Published from abecms/visualq-mcp. Backend routes live in abecms/visualq (/api/mcp/v1/invoke).

About

MCP server for VisualQ visual regression testing

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors