Applitools

Install

Config snippet generator goes here (5 client tabs)

README

# 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](https://applitools.com/docs/eyes/playwright), 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.

To [learn more](https://applitools.com/docs/eyes/integrations/mcp-servers/applitools-mcp), please visit our MCP documentation.

## 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)
    * Expand visual checkpoints in existing tests
    * 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](https://applitools.com/docs/eyes/playwright) only.
  * It is recommended using the most recent versions of Playwright Node.js and our Playwright JavaScript Fixtures SDK
  * Requires projects utilizing [Playwright Test](https://playwright.dev/docs/api/class-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 directly in Cursor.

  * Runs the MCP server automatically
  * Connects it to your AI assistant
  * Provide context-aware code edits
  * Surface visual test results inside your IDE or MCP client CLI of choice

<a href="https://marketplace.visualstudio.com/items?itemName=applitools-mcp">
  <img src="https://img.shields.io/badge/Install-VS_Code-007ACC?logo=visualstudiocode&logoColor=white">
</a>

<a href="cursor://anysphere.cursor-deeplink/mcp/install?name=applitools-mcp&config=eyJjb21tYW5kIjoibnB4IC15IEBhcHBsaXRvb2xzL21jcEBsYXRlc3QifQ">
  <img src="https://img.shields.io/badge/Install-Cursor-000000">
</a>
<br></br>

Alternatively, you can install the server manually by following the `Manual Setup` section below.

### What's Included

* Automatic MCP server management
* 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, you can install the MCP server manually by following the examples below.

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

<details>
  <summary>VS Code</summary>
Please see the [VS Code MCP install guide](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) 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"]}'`
</details>

<details>
  <summary>Copilot</summary>

Create or edit the configuration file ~/.copilot/mcp-config.json and add:
```
{
 "mcpServers": {
   "applitools-mcp": {
     "type": "local",
     "command": "npx",
     "tools": [
       "*"
     ],
     "args": [
       "@applitools/mcp@latest"
     ]
   }
 }
}
```
</details>

<details>
  <summary>Cursor</summary>
In your user root directory, edit or add the above configuration to your `~/.cursor/mcp.json` file.

Alternatively, go to Cursor Settings -> MCP -> Add new MCP Server. Name it `applitools-mcp`, use `command` type with the command `npx -y @applitools/mcp@latest`. 
</details>

<details>
  <summary>Cline</summary>
Follow the instruction in the section [Configuring MCP Servers](https://docs.cline.bot/mcp/configuring-mcp-servers)

Add the following to your `cline_mcp_settings.json` file:

```
{
  "mcpServers": {
    "applitools-mcp": {
      "command": "npx",
      "args": ["--yes", "@applitools/mcp@latest"],
      "disabled": false,
      "type": "stdio",
	   "timeout": 60
    }
  }
}
```
</details>

<details>
  <summary>Claude Code (CLI)</summary>
Use the Claude Code CLI to add the Playwright MCP server:

`claude mcp add applitools-mcp npx @applitools/mcp@la