Tools Reference

The VertaaUX MCP Server provides 7 primary tools for UX auditing and AI-powered fixes.

All Tools

Tool	Purpose	Key Use Case
`audit_url`	Audit a deployed website	Primary entry point for web audits
`audit_repo`	Audit local codebase	Coming soon - static analysis
`audit_artifact`	Audit from captured artifacts	Offline/CI use cases
`get_findings`	Get findings from audit	Retrieve detailed findings list
`explain_finding`	Get detailed explanation	Understand why an issue matters
`suggest_fix`	Generate code patch	Get AI-suggested code fixes
`generate_pr`	Create draft PR	Apply multiple fixes as PR

Typical Workflow

Most workflows follow this pattern:

audit_url → get_findings → explain_finding → suggest_fix → generate_pr
     ↓            ↓              ↓                ↓            ↓
  Run audit   Get list    Understand issue   Get fix code   Create PR

Start Here: audit_url

For most users, start with audit_url:

"Audit https://mysite.com for accessibility issues"

This runs a full audit and returns a summary with top findings.

Dig Deeper: get_findings

To see all findings with filtering:

"Get all critical findings from audit abc123"

Filter by severity, rule ID, or status.

Understand: explain_finding

Before fixing, understand the issue:

"Explain finding xyz789 - why does this matter?"

Get WCAG references, impact on users, and examples.

Fix: suggest_fix

Get AI-generated code patches:

"Suggest a fix for finding xyz789"

Returns search/replace patch with confidence score.

Ship: generate_pr

Create a PR with multiple fixes:

"Create a PR to fix all critical findings"

Generates draft PR with all suggested patches.

Tool Categories

Auditing Tools

Tool	Description	Status
`audit_url`	Audit deployed URL	Available
`audit_repo`	Audit local repository	Coming soon
`audit_artifact`	Audit from artifacts	Available

audit_repo note: Currently returns a placeholder message. Static analysis is not yet implemented. Use audit_url with a deployed or localhost URL for now.

Data Access Tools

Tool	Description
`get_findings`	Retrieve findings from completed audit
`explain_finding`	Get detailed explanation with WCAG reference

Remediation Tools

Tool	Description
`suggest_fix`	Generate AI-powered code patch
`generate_pr`	Create GitHub PR with fixes

Tool Details

audit_url

Audit any deployed website URL

get_findings

Retrieve and filter audit findings

explain_finding

Understand why an issue matters

suggest_fix

Get AI-generated code patches

Common Tool Combinations

Quick Audit Flow

audit_url (mode: basic) → Review summary

Best for: Quick checks, verifying fixes.

Deep Analysis Flow

audit_url (mode: deep) → get_findings (filter: critical) → explain_finding

Best for: Thorough accessibility reviews, compliance audits.

Fix Flow

audit_url → suggest_fix → (apply manually)

Best for: Fixing individual issues with AI guidance.

Bulk Fix Flow

audit_url → get_findings → suggest_fix (batch) → generate_pr

Best for: Fixing multiple issues at once, creating PRs for review.

Error Handling

All tools return errors in a consistent format:

Error	Cause	Solution
`UNAUTHORIZED`	Invalid API key	Check API key configuration
`QUOTA_EXCEEDED`	Monthly limit reached	Upgrade plan or wait for reset
`INVALID_URL`	Malformed or inaccessible URL	Verify URL is publicly accessible
`AUDIT_TIMEOUT`	Audit exceeded timeout	Increase timeout or use basic mode
`FINDING_NOT_FOUND`	Finding ID doesn't exist	Verify finding ID from get_findings

Resource URIs - Access audit data via vertaa:// URIs
Setup Guide - Configure MCP Server
API Reference - REST API documentation

Was this page helpful?

Tools Reference

audit_url

get_findings

explain_finding

suggest_fix

On this page