@applitools/mcp 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,144 @@
+# Changelog
+
+All notable changes to the Applitools Eyes MCP will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.4.0](https://github.com/Applitools-Dev/sdk/compare/js/mcp@0.3.0...js/mcp@0.4.0) (2026-03-08)
+
+
+### Features
+
+* mcp improved naming conventions | AD-12875 ([#3611](https://github.com/Applitools-Dev/sdk/issues/3611)) ([6f1020e](https://github.com/Applitools-Dev/sdk/commit/6f1020e08015d74c108780ca63716ffda36a7472))
+* release java ([7bc39e6](https://github.com/Applitools-Dev/sdk/commit/7bc39e679eab27a19322ca4b121177da7437c106))
+
+## [0.3.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-mcp@0.2.1...js/eyes-mcp@0.3.0) (2026-03-02)
+
+
+### Features
+
+* http 2 support | FLD-4085 ([#3539](https://github.com/Applitools-Dev/sdk/issues/3539)) ([b304d4a](https://github.com/Applitools-Dev/sdk/commit/b304d4a1072a201d1c3f5cea1275b6a15230d6aa))
+
+
+### Dependencies
+
+* @applitools/req bumped to 1.9.0
+  #### Features
+
+  * http 2 support | FLD-4085 ([#3539](https://github.com/Applitools-Dev/sdk/issues/3539)) ([b304d4a](https://github.com/Applitools-Dev/sdk/commit/b304d4a1072a201d1c3f5cea1275b6a15230d6aa))
+* @applitools/core-base bumped to 1.32.0
+  #### Features
+
+  * http 2 support | FLD-4085 ([#3539](https://github.com/Applitools-Dev/sdk/issues/3539)) ([b304d4a](https://github.com/Applitools-Dev/sdk/commit/b304d4a1072a201d1c3f5cea1275b6a15230d6aa))
+
+
+  #### Bug Fixes
+
+  * video link with http live streaming - workaround | FLD-4089 ([#3567](https://github.com/Applitools-Dev/sdk/issues/3567)) ([8639c37](https://github.com/Applitools-Dev/sdk/commit/8639c37d39997915d5fcdc46c45a96d510b6ad91))
+
+
+
+
+## [0.2.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-mcp@0.2.0...js/eyes-mcp@0.2.1) (2026-03-01)
+
+
+### Performance Improvements
+
+* use sharp to accelerate png performance in all js packages ([#3547](https://github.com/Applitools-Dev/sdk/issues/3547)) ([6e3c7b9](https://github.com/Applitools-Dev/sdk/commit/6e3c7b9e34815f470032ece52a161001592ad1b1))
+
+
+### Dependencies
+
+* @applitools/image bumped to 1.2.7
+  #### Performance Improvements
+
+  * use sharp to accelerate png performance in all js packages ([#3547](https://github.com/Applitools-Dev/sdk/issues/3547)) ([6e3c7b9](https://github.com/Applitools-Dev/sdk/commit/6e3c7b9e34815f470032ece52a161001592ad1b1))
+* @applitools/core-base bumped to 1.31.3
+  #### Performance Improvements
+
+  * use sharp to accelerate png performance in all js packages ([#3547](https://github.com/Applitools-Dev/sdk/issues/3547)) ([6e3c7b9](https://github.com/Applitools-Dev/sdk/commit/6e3c7b9e34815f470032ece52a161001592ad1b1))
+
+
+
+
+## [0.2.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-mcp@0.1.0...js/eyes-mcp@0.2.0) (2026-02-16)
+
+
+### Features
+
+* mcp server test results support and improvements to initial setup ([#3518](https://github.com/Applitools-Dev/sdk/issues/3518)) ([ef6c27b](https://github.com/Applitools-Dev/sdk/commit/ef6c27b9e35dc54fd588e19a4811631433e15dbb))
+
+
+### Dependencies
+
+* @applitools/logger bumped to 2.2.8
+  #### Bug Fixes
+
+  * use utils for environment variable retrieval in logger handlers ([#3551](https://github.com/Applitools-Dev/sdk/issues/3551)) ([caf97f3](https://github.com/Applitools-Dev/sdk/commit/caf97f34207bc3b8ee6ccda2855c27a99a262f8c))
+
+
+  #### Performance Improvements
+
+  * add timing logs to classic | FLD-4137 ([#3543](https://github.com/Applitools-Dev/sdk/issues/3543)) ([de2b0aa](https://github.com/Applitools-Dev/sdk/commit/de2b0aaf08d813f2c59e9552947c2f4fbc12da48))
+* @applitools/req bumped to 1.8.8
+
+* @applitools/test-server bumped to 1.4.0
+  #### Features
+
+  * make eyes-browser truly browser-importable ([#3512](https://github.com/Applitools-Dev/sdk/issues/3512)) ([9574a2f](https://github.com/Applitools-Dev/sdk/commit/9574a2fa45ec80466dfe93744c8a736f40fb51c3))
+  * mcp server test results support and improvements to initial setup ([#3518](https://github.com/Applitools-Dev/sdk/issues/3518)) ([ef6c27b](https://github.com/Applitools-Dev/sdk/commit/ef6c27b9e35dc54fd588e19a4811631433e15dbb))
+
+
+
+* @applitools/core-base bumped to 1.31.2
+
+
+## [0.1.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-mcp-server-v0.0.1...js/eyes-mcp-server@0.1.0) (2026-01-28)
+
+
+### Features
+
+* release java ([7bc39e6](https://github.com/Applitools-Dev/sdk/commit/7bc39e679eab27a19322ca4b121177da7437c106))
+
+## [Unreleased]
+
+### Changed
+- **BREAKING**: Recommended server name changed from `"applitools-eyes"` to `"eyes"` for shorter tool names
+  - Tool names now appear as `mcp__eyes__info` instead of `mcp__applitools-eyes__info`
+  - Old server name still works for backward compatibility
+- Reorganized tools directory structure for better code separation
+  - Each tool now resides in its own subdirectory under `src/tools/`
+  - Updated import paths to reflect new structure
+
+### Added
+- VS Code Extension support for automatic MCP server registration
+  - Auto-registers with VS Code, Cline, and Claude Code
+  - Auto-cleanup on extension uninstall
+- Claude Code integration in VS Code Extension
+- Comprehensive documentation in `src/tools/README.md` for tool development
+- Project structure section in main README
+- Development and Contributing sections in main README
+
+### Fixed
+- Import paths updated to work with new directory structure
+
+## [1.0.0] - 2025-01-04
+
+### Added
+- Initial release of Applitools Eyes MCP
+- `info` tool for server capabilities information
+- `version` tool for version information display
+- Support for stdio and SSE (HTTP) transports
+- Dual-mode server operation (stdio by default, SSE with --port flag)
+- Clear attribution and branding for all tool responses
+- Comprehensive error handling
+- Zero-configuration setup via npx
+
+### Documentation
+- Complete README with installation instructions
+- Configuration examples for Cursor, VS Code, Cline, and Claude Code
+- Usage examples and prompts
+
+[Unreleased]: https://github.com/applitools/eyes.sdk.javascript/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/applitools/eyes.sdk.javascript/releases/tag/v1.0.0

package/LICENSE

@@ -0,0 +1,26 @@
+-  -
+SDK LICENSE AGREEMENT
+IMPORTANT - PLEASE READ CAREFULLY THE TERMS OF THIS LICENSE AGREEMENT (“AGREEMENT”). BY INSTALLING, ACCESSING AND/OR USING THE SOFTWARE (AS DEFINED BELOW), YOU EXPRESSLY ACKNOWLEDGE AND AGREE THAT YOU, OR THE COMPANY YOU REPRESENT, (“YOU” OR “LICENSEE”) ARE ENTERING INTO A LEGAL AGREEMENT WITH APPLITOOLS LTD. AND ITS AFFILIATES (“APPLITOOLS”), AND HAVE UNDERSTOOD AND AGREE TO COMPLY WITH, AND BE LEGALLY BOUND BY, THE TERMS AND CONDITIONS OF THIS AGREEMENT. YOU HEREBY WAIVE ANY RIGHTS OR REQUIREMENTS UNDER ANY LAWS OR REGULATIONS IN ANY JURISDICTION WHICH REQUIRE AN ORIGINAL (NON-ELECTRONIC) SIGNATURE OR DELIVERY OR RETENTION OF NON-ELECTRONIC RECORDS, TO THE EXTENT PERMITTED UNDER APPLICABLE LAW. 
+THE SOFTWARE MAY BE USED SOLELY FOR YOUR PERSONAL, NON-COMMERCIAL PURPOSES. FOR COMMERCIAL PURPOSES PLEASE CONTACT THE REGIONAL APPLITOOLS BUSINESS REPRESENTATIVE. 
+1. Definitions. For purposes of this Agreement, the following capitalized terms shall have the following meaning:
+   1. “Documentation” means the user’s guides and technical manuals delivered by Applitools to Licensee.
+   2.  “Feedback” means suggestions, comments or feedback (whether orally or in writing) with respect to the Software.
+   3. “Intellectual Property Rights” means all intangible legal rights, titles and interests evidenced by or embodied in all: (i) inventions (regardless of patentability and whether or not reduced to practice), improvements thereto, patents, patent applications, patent disclosures, together with all reissuances, continuations, continuations in part, revisions, extensions and reexaminations thereof; (ii) trademarks, service marks, trade dress, logos, trade names, corporate names, together with translations, adaptations, derivations and combinations thereof, including goodwill associated therewith, and applications, registrations, and renewals in connection therewith; (iii) any work of authorship, regardless of copyrightable, copyrightable works, copyrights (including moral rights), and applications, registrations and renewals in connection therewith; (iv) mask works and applications, registrations and renewals in connection therewith; (v) trade secrets and Confidential Information; and (vi) other proprietary rights and any other similar rights, in each case on a worldwide basis, and copies and tangible embodiments thereof, in whatever form or medium.
+   4. “License” means the right to use the Software pursuant to Section ‎2.1 to this Agreement.
+   5.  “Software” means Applitools’ software development kit software in object or source code version, Documentation and any updates and upgrade thereto (to the extent delivered).
+1. License
+   1. Grant of License. Subject to the terms and conditions of this Agreement, Applitools grants You, during the Term, a personal, non-exclusive, non-sublicensable, non-transferable, revocable license to: (i) use the Software solely for Your own personal (non-commercial) use and (ii) use and display Applitools’ Marks solely for the purpose of publicizing or advertising that You are using the Software. 
+   2. Documentation. Applitools may make available Documentation to Licensee for Licensee to use solely in connection with Licensee’s use of the Software during the term of this Agreement. Licensee may print or copy the Documentation as needed for its own purposes provided that all copyright notices are included therein. The Documentation shall be considered the Confidential Information of Applitools. 
+   1. Reservation of Rights; Use Restrictions. Other than the rights explicitly granted in this Agreement, Licensee shall have no other rights, express or implied, in the Software. Without limiting the generality of the foregoing, Licensee agrees and undertakes not to: (i) allow any third party to use the Software in any manner, including but not limited to, sell, lease, sublicense or distribute the Software, or any part thereof; (ii) modify, revise, or alter the Software or reverse engineer, decompile, disassemble or otherwise reduce to human-perceivable form the Software’s source code; (iii) copy or allow copies of the Software to be made; (iv) remove, alter or obscure any proprietary notice or identification, including copyright, trademark, patent or other notices, contained in or displayed on or via the Software; (v) use the Software to violate any applicable laws, rules or regulations, or for any unlawful, harmful, irresponsible, or inappropriate purpose, or in any manner that breaches this Agreement, and/or (vi) represent that it possesses any proprietary interest in the Software.
+   1. Third Party Software. Licensee acknowledges and agrees that any third party software (“Third Party Software”) that provided with the Software is provided under the terms of the license attached/linked thereto or, if no such license is attached, such Third Party Software is provided for free and on “AS IS” basis. Applitools is not liable for any losses or damages which may occur resulting from the use of any Third Party Software. Applitools does not possess any proprietary interest in such Third Party Software. 
+   1. Open Source Licenses. The Software includes certain open source code software and materials (as shall be listed in the documentation of the Software) (“Open Source Software”) that are subject to their respective open source licenses (“Open Source Licenses”). Such Open Source Licenses contain a list of conditions with respect to warranty, copyright policy and other provisions. By executing this Agreement, Licensee undertakes to strictly comply with the terms and condition of the Open Source Licenses, as may be amended from time to time. In order to comply with the Open Source Licenses, Licensee shall read the respective licenses or notices, such list of Open Source Licenses may be amended from time to time by Applitools, at its sole discretion. In the event of any inconsistencies or conflicting provisions between the provisions of the Open Source Licenses and the provisions of this Agreement, the provisions of the Open Source Licenses shall prevail. Without derogating from the generality of the foregoing, it is clarified that any Open Source Software is provided on an “AS IS” basis, without indemnity or warranty of any kind, whether express or implied. For clarity, the representations and warranties set forth in Section ‎4 hereunder shall not apply to any Open Source Software.
+1. Title & Ownership. APPLITOOLS DOES NOT SELL OR TRANSFER TITLE IN THE SOFTWARE, OR ANY PART THEREOF, TO LICENSEE. The Documentation, Software (excluding any Open Source Software and Third Party Software therein which are owned by their respective licensors) and/or any copies thereof, including without limitation any derivative works made (regardless of whether such derivative works were made and/or developed pursuant to the request and/or specifications of Licensee, and irrespective of any support and/or assistance Applitools may, will or had received from Licensee, or any third party on its behalf, with respect thereto), as well as any updates or upgrades thereto, if provided to Applitools pursuant to this Agreement, shall remain Applitools’ sole and exclusive property. All Intellectual Property Rights evidenced by or embodied in and/or attached/connected/related to the Software, or part thereof, are and shall be owned solely and exclusively by Applitools. Nothing in this Agreement shall constitute a waiver of Applitools’ Intellectual Property Rights under any law, or be in any way construed or interpreted as such. It is further agreed that to the extent Licensee provides Applitools with Feedback, Licensee acknowledges that any and all rights, including Intellectual Property Rights in such Feedback shall belong exclusively to Applitools and Licensee hereby irrevocably and unconditionally transfers and assigns to Applitools all intellectual property rights in such Feedback and waives any and all moral rights that Licensee may have in respect thereto. It is further understood that use of Feedback, if any, may be made by Applitools at its sole discretion, and that Applitools in no way shall be obliged to make use of any kind of the Feedback or part thereof. 
+1. Warranty. Applitools warrants that to its knowledge it has the right to grant the license under this Agreement. Applitools’ sole liability for any breach of this warranty or any other warranty under this Agreement shall be, at Applitools’ sole discretion: (i) to replace or repair the Software or the applicable portion thereof; or (ii) to terminate this Agreement.
+2. Warranty Exclusions. The warranties set forth in Section ‎4 are contingent upon Licensee’s proper use of the Software, and shall not apply to damage caused by abuse, misuse, alteration, neglect or unauthorized repair or installation, or by the use or attempted use of Software other than that supplied and supported by Applitools. Applitools will use reasonable commercial efforts to repair or replace the Software or the applicable portion thereof, pursuant to the foregoing warranty within thirty (30) days of being so notified.
+1. Warranty Disclaimers. AS BETWEEN LICENSEE AND APPLITOOLS, EXCEPT AS SET IN SECTION ‎4, THE SOFTWARE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS WITHOUT WARRANTIES OF ANY KIND INCLUDING, WITHOUT LIMITATION, REPRESENTATIONS, WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR INTENDED OR PARTICULAR PURPOSE, TITLE, NON-INFRINGEMENT, THAT THE SOFTWARE WILL MEET LICENSEE’S REQUIREMENTS OR EXPECTATIONS OR WILL ACHIEVE ANY SPECIFIC RESULTS AND THOSE ARISING BY STATUTE OR FROM A COURSE OF DEALING OR USAGE OF TRADE. Applicable law may not allow the exclusion of certain warranties, so to that extent such exclusions may not apply.
+1. High Risk Activities. You acknowledge that the Software is not fault tolerant and is not designed, manufactured, or intended for use or resale as on-line control equipment in hazardous or high risk environments and activities requiring fail-safe performance (such as in the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, direct life support machines and/or devices, or weapons systems) in which the failure of the Software could lead directly to death, personal injury, or severe physical or environmental damage, and You agree not to use or allow the use of the Software or any portion thereof for, or in connection with, any such environment or activity.
+1. Indemnify. You agree that Applitools shall have no liability whatsoever for any use made of the Software by You or any third party. You hereby agree to defend, indemnify and hold harmless Applitools and its affiliates and their respective officers, directors, agents and employees from any and all claims, damages, liabilities, costs, and expenses (including attorney’s fees) arising from claims related to Your use of the Software as well as from Your failure to comply with this Agreement.
+1. Limitation of Liability. UNDER NO CIRCUMSTANCES SHALL APPLITOOLS AND/OR ITS AFFILIATES BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, OR FOR ANY LOSS OF DATA, REVENUE, BUSINESS OR REPUTATION, THAT ARISES UNDER OR IN CONNECTION WITH THIS AGREEMENT, OR THAT RESULTS FROM THE USE OF, OR THE INABILITY TO USE, THE SOFTWARE. APPLITOOLS’S TOTAL AGGREGATE LIABILITY FOR ANY AND ALL DIRECT DAMAGES AND LOSSES THAT ARISE UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL NOT IN ANY CIRCUMSTANCE EXCEED THE AMOUNT OF 100.00 (ONE HUNDRED) UNITED STATES DOLLARS. THE FOREGOING LIMITATIONS AND EXCLUSIONS IN THIS SECTION ‎7 SHALL APPLY: (I) EVEN IF APPLITOOLS HAS BEEN ADVISED OF THE POSSIBILITY OF ANY DAMAGES OR LOSSES; (II) EVEN IF ANY REMEDY SET FORTH HEREIN FAILS OF ITS ESSENTIAL PURPOSE; AND (III) REGARDLESS OF THE BASIS OR THEORY OF LIABILITY.
+1. Export Laws. Licensee agrees to comply fully with all U.S., EU, Israeli, and all applicable export laws and regulations to ensure that neither the Software nor any technical data related thereto are exported or re-exported directly or indirectly in violation of, or used for any purposes prohibited by, such laws and regulations. For clarity, and without derogating from Section ‎11 below, in case of any change of any applicable law, policy or regulation, which might affect Applitools’ business, Applitools will have the right to terminate this Agreement and the license granted hereunder and the Licensee shall have no claims regarding such termination. 
+1. Term and Termination. This Agreement shall continue until terminated as set forth in this section (the “Term”). You may terminate this Agreement at any time by removing the Software from Your system and destroying all copies of the Software and Documentation relating to the Software. Unauthorized copying of the Software or otherwise failing to comply with this Agreement will result in automatic immediate termination of this Agreement and will make available to Applitools legal remedies. Applitools reserves the right to terminate this Agreement and the License at any time and without notice. Upon termination of this Agreement, the License will terminate and You: (i) will cease any and all rights to use the Software, and (ii) will remove the Software from all hard drives, networks and other storage media and destroy all copies of the Software in your possession or under your control. The provisions of Sections ‎2.3, ‎2.4, ‎2.5, ‎6, ‎7, ‎8, ‎9, 10, ‎11 and ‎12 shall survive the termination, expiration or other ending of this Agreement.
+1. Miscellaneous. This Agreement represents the complete agreement concerning the Software between You and Applitools and supersedes all prior agreements and representations between You and Applitools. If any provision of this Agreement is held to be unenforceable for any reason, such provision shall be reformed only to the extent necessary to make it enforceable. Any waiver of any provision of this Agreement will be effective only if in writing and signed by Applitools. This Agreement is personal to You and may not be assigned or transferred for any reason whatsoever without the consent of Applitools and any action or conduct in violation of the foregoing shall be void and without effect. Applitools expressly reserves the right to assign this Agreement and to delegate any of its obligations hereunder. This Agreement are governed by and construed under the laws of the State of Israel, excluding its conflicts of law rules. You expressly agree that the exclusive jurisdiction for any claim or action arising out of or relating to this Agreement shall be the courts located in Tel Aviv, Israel, and You further agree and submit to the exercise of personal jurisdiction of such courts for the purpose of litigating any such claim or action. In any action or proceeding to enforce rights under this Agreement, the prevailing party shall be entitled to recover costs and attorneys’ fees.

package/README.md

@@ -0,0 +1,213 @@
+# 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@latest`
+</details>
+
+<details>
+  <summary>Claude Desktop</summary>
+
+Follow the MCP install [guide](https://modelcontextprotocol.io/docs/develop/connect-local-servers), and use the standard MCP configuration above.
+</details>
+
+## Available Tools
+
+### eyes_verify_api_key
+Checks your Applitools API key and optional Eyes server URL. 
+
+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.
+
+## Getting started & Usage
+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"
+
+## Helpful links
+
+* [Applitools MCP Documentation](https://applitools.com/docs/eyes/integrations/mcp-servers/applitools-mcp)
+* [Applitools Playwright Fixtures SDK](https://applitools.com/docs/eyes/playwright)
+* [Contact Support](https://help.applitools.com/hc/en-us/requests/new)
+
+---
+
+Built with ❤️ by Applitools

package/dist/docs/README.md

@@ -0,0 +1,213 @@
+# 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@latest`
+</details>
+
+<details>
+  <summary>Claude Desktop</summary>
+
+Follow the MCP install [guide](https://modelcontextprotocol.io/docs/develop/connect-local-servers), and use the standard MCP configuration above.
+</details>
+
+## Available Tools
+
+### eyes_verify_api_key
+Checks your Applitools API key and optional Eyes server URL. 
+
+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.
+
+## Getting started & Usage
+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"
+
+## Helpful links
+
+* [Applitools MCP Documentation](https://applitools.com/docs/eyes/integrations/mcp-servers/applitools-mcp)
+* [Applitools Playwright Fixtures SDK](https://applitools.com/docs/eyes/playwright)
+* [Contact Support](https://help.applitools.com/hc/en-us/requests/new)
+
+---
+
+Built with ❤️ by Applitools