Skip to main content

Applitools MCP Server

The Applitools MCP server helps you create, update, and analyze visual tests using Applitools Eyes with our Playwright (JavaScript/TypeScript) Fixtures SDK, with support for more frameworks coming soon.

It connects to AI assistants through the Model Context Protocol (MCP), allowing tools like Cline, Claude Code, and IDE assistants to help you set up tests, add visual checkpoints, and configure cross-browser testing.

Purpose​

This server is built for developers, testers, or QA working with AI-assisted workflows.

It enables your AI assistant to:

  • Understand your project configuration
  • Guide Eyes setup
  • Add visual checkpoints and suggest best practices
  • Review your visual test results

All without requiring manual, error-prone steps.

Who is this for?​

  • New users to test automation
    • No existing automation framework.
  • Playwright JavaScript engineers new to Applitools Eyes
    • Playwright is already used, but Eyes has not yet been installed or implemented.
  • Existing Eyes Playwright Fixtures users
    • Who want to use the MCP server to:
      • Add Ultrafast Grid coverage (cross-browser and device testing)
      • Quickly convert existing tests into visual tests using Appplitools visual AI
      • Retrieve and analyze your visual test results

Requirements & Limitations​

  • Node.js 18 or newer
  • VS Code, Cursor, Claude Desktop, or any other MCP client assistant
  • Supports Playwright JavaScript/TypeScript projects and our Playwright Fixtures SDK only.
    • It is recommended using the most recent versions of Playwright Node.js and our Playwright JavaScript Fixtures SDK
    • Requires projects utilizing Playwright Test
  • Requires access to your projects source code

Installation​

Recommended: VS Code Extension or Cursor MCP Install

The easiest way to start using Eyes MCP is through the Applitools VS Code extension or by installing the MCP server in Cursor.

  • Runs the MCP server automatically
  • Connects it to Copilot in VS Code or Cursor's AI assistant automatically
  • Provide context-aware code edits
  • Surface visual test results inside your IDE or MCP client CLI of choice

Simply install the MCP server by clicking an option below:

What's Included​

  • Automatic MCP server management for Copilot in VS Code or Cursor's AI assistant
  • Seamless IDE + AI assistant integration
  • Context-aware assistance based on open files
  • Smart code edits and checkpoint suggestions
  • Visual test results directly inside your IDE

Manual Setup​

If you prefer not to use the extension or use a different MCP client, you can manually install the MCP server by following the examples below.

Standard MCP configuration (Work for most clients)​

{
  "mcpServers": {
    "applitools-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["--yes", "@applitools/mcp@latest"]
    }
  }
}

IDE's & MCP Clients​

Please see the VS Code MCP install guide and use the standard config above.

Alternatively, install it via the VS Code CLI:

code --add-mcp '{"name":"applitools-mcp","command":"npx","args":["@applitools/mcp@latest"]}'

Available Tools​

eyes_verify_api_key​

Validates your Applitools API key and, if provided, verifies connectivity to a specified Eyes server URL (e.g., non-public cloud).

Searches common locations:

  • APPLITOOLS_API_KEY environment variable and/or APPLITOOLS_SERVER_URL, if applicable
  • .env
  • applitools.config.*
  • playwright.config.*

eyes_setup_project​

Guides the setup of Applitools Eyes in your Playwright project (Fixtures variant).

Includes:

  • The Eyes reporter configuration
    • Extends the Playwright HTML report to include Eyes visual test results. Users can approve or reject results in the report without having to visit the Eyes dashboard.
  • Adding Eyes settings and dependency imports into your project files
  • Recommended defaults

eyes_add_checkpoints_to_test​

Adds Eyes visual checkpoints to your existing Playwright test in line with best practices.

eyes_setup_ufg​

Configures the Ultrafast Grid (UFG) for cross-browser and cross-device testing. Guides you through UFG setup to run visual tests across multiple browsers, viewports, and devices simultaneously.

eyes_fetch_visual_results​

Retrieves structured visual test results, including:

  • The Eyes batch name
  • The visual tests that ran
  • The visual test statuses (passed/failed/new/unresolved/etc.)

eyes_get_batch_url​

Extracts and converts Eyes test result URLs from console output. Parses test execution output to find session URLs and converts them to batch URLs for viewing all test results together in the Eyes dashboard.

Usage Examples​

Ask your AI assistant about Applitools:

  • “Using the Applitools MCP server, perform the following tasks”
    • This prompt prefix is optional and can guide your LLM and direct it to use the MCP server for better results.
  • "Set up Applitools Eyes for my project"
  • "Verify my Applitools API key"
  • "Add Eyes visual checkpoints to my login.spec test"
  • "Configure cross-browser testing with the Applitools UFG"
  • "Show me the batch URL for my last test results"
  • "Provide me a summary of my last visual test results"

Built with ❤️ by Applitools