Package Exports

@uuv/mcp-server

Readme

UUV MCP Server

This library is an MCP (Model Context Protocol) server for UUV - a solution to facilitate the writing and execution of E2E tests understandable by any human being(English or French) using cucumber(BDD) and cypress or playwright.

Requirements

Node.js 20
Opencode, Claude Desktop, Goose or any other MCP client
Playwright MCP Server

Getting started

First, install the UUV MCP server with your client.

Standard config works in most of the tools:

{
  "mcpServers": {
    "uuv": {
      "command": "npx",
      "args": [
        "@uuv/mcp-server@latest"
      ]
    }
  }
}

Opencode

Follow the MCP Servers documentation. For example in ~/.config/opencode/opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "uuv": {
      "type": "local",
      "command": [
        "npx",
        "@uuv/mcp-server@latest"
      ],
      "enabled": true
    }
  }
}

You can also use the following file as inspiration to configure a dedicated agent for writing tests: https://github.com/e2e-test-quest/uuv/tree/main/packages/mcp-server/agents/uuv-assistant.md

Claude Code

Use the Claude Code CLI to add the Marketplace plugin for the UUV:

claude plugin marketplace add https://github.com/e2e-test-quest/uuv

Then use the Claude Code CLI to add specific UUV's plugin:

claude plugin install uuv-e2e-accessibility-test@uuv-e2e-accessibility-test-marketplace

Then use the Claude Code CLI to add the UUV MCP server:

claude mcp add uuv npx @uuv/mcp-server@latest

Gemini CLI

To add the UUV Extension:

gemini extensions install https://github.com/e2e-test-quest/uuv --auto-update

To remove the UUV Extension:

gemini extensions uninstall uuv-e2e-accessibility-test

Exposed MCP Tools

This MCP server exposes the following tools:

getBaseUrl

Description: Retrieve project base url for generated UUV tests. In terms of priority, the UUV_BASE_URL environment variable is read, and if it is empty, the value of the baseURL field in the projectPath/uuv/playwright.config.ts or projectPath/uuv/cypress.config.ts file is checked.
Input Schema:
- projectPath (string): Project absolute path

availableSentences

Description: List all available UUV test sentences/phrases in Gherkin format.
Input Schema:
- category (enum, optional): Filters sentences by action type (general, keyboard, click, contains, type, checkable)
- role (string, optional): Filters sentences related to an accessible role

genTestExpectRoleAndName

Description: Generate a complete UUV test scenario (Gherkin format) to verify the presence of an element with specified role and name.
Input Schema:
- baseUrl (string): The base URL of the page where the element is located
- accessibleRole (string): Accessible role of the element
- accessibleName (string): Accessible name of the element

genTestExpectDomSelector

Description: Generate a complete UUV test scenario (Gherkin format) to verify the presence of an element with specified domSelector.
Input Schema:
- baseUrl (string): The base URL of the page where the element is located
- domSelector (string): Dom selector of the element

genTestClickRoleAndName

Description: Generate a complete UUV test scenario (Gherkin format) that clicks on html element with specified role and name.
Input Schema:
- baseUrl (string): The base URL of the page where the element is located
- accessibleRole (string): Accessible role of the element
- accessibleName (string): Accessible name of the element

genTestClickDomSelector

Description: Generate a complete UUV test scenario (Gherkin format) that clicks on html element with specified domSelector.
Input Schema:
- baseUrl (string): The base URL of the page where the element is located
- domSelector (string): Dom selector of the element

genTestWithinRoleAndName

Description: Generate a complete UUV test scenario (Gherkin format) that focus within a html element with specified role and name.
Input Schema:
- baseUrl (string): The base URL of the page where the element is located
- accessibleRole (string): Accessible role of the element
- accessibleName (string): Accessible name of the element

genTestWithinDomSelector

Description: Generate a complete UUV test scenario (Gherkin format) that focus within a html element with specified domSelector.
Input Schema:
- baseUrl (string): The base URL of the page where the element is located
- domSelector (string): Dom selector of the element

genTestTypeRoleAndName

Description: Generate a complete UUV test scenario (Gherkin format) that focus within a html element with specified role and name.
Input Schema:
- baseUrl (string): The base URL of the page where the element is located
- accessibleRole (string): Accessible role of the element
- accessibleName (string): Accessible name of the element

genTestExpectTable (WIP)

Description: Generate a complete UUV test scenario (Gherkin format) to verify the presence and content of html table, grid or treegrid.
Input Schema:
- baseUrl (string): The base URL of the page where the table/grid/treegrid is located
- innerHtmlFilePath (string): File path containing the raw innerHTML content

Exposed MCP Prompts

This MCP server exposes the following prompts: