@uuv/mcp-server 0.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+
+
+                                    MIT License
+
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal in
+        the Software without restriction, including without limitation the rights to use,
+        copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+        Software, and to permit persons to whom the Software is furnished to do so,
+        subject to the following conditions:
+
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+        OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+        HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+        WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+        FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+        OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# 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.
+
+## Exposed MCP Tools
+
+This MCP server exposes the following tools:
+
+### 1. retrieve_prompt
+- **Description**: Retrieve a uuv prompt template for a coding agent based on a prompt name and arguments.
+- **Input Schema**:
+  - `promptName` (enum): Either "generate_table" or "generate_role_and_name"
+  - `baseUrl` (string): The base URL of the page
+  - For generate_role_and_name:
+    - `accessibleName` (string, optional): Accessible name 
+    - `accessibleRole` (string, optional): Accessible role
+
+### 2. available_sentences
+- **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
+
+### 3. generate_role_and_name
+- **Description**: Generate a complete UUV test scenario (Gherkin format) to verify the presence of an element with specified accessible name and role.
+- **Input Schema**:
+  - `baseUrl` (string): The base URL of the page where the element is located
+  - `accessibleName` (string): Accessible name of the element
+  - `accessibleRole` (string): Accessible role of the element
+
+### 4. generate_table
+- **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
+
+## Command
+Add the following command to execute **UUV MCP Server** `npx @uuv/mcp-server`.
+
+### Opencode configuration example (opencode.json)
+```json
+...
+  "mcp": {
+    "playwright": {
+      "type": "local",
+      "enabled": true,
+      "command": [
+        "npx",
+        "@uuv/mcp-server@latest"
+      ]
+    }
+  }
+...
+```

package/dist/README.md

@@ -0,0 +1,54 @@
+# 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.
+
+## Exposed MCP Tools
+
+This MCP server exposes the following tools:
+
+### 1. retrieve_prompt
+- **Description**: Retrieve a uuv prompt template for a coding agent based on a prompt name and arguments.
+- **Input Schema**:
+  - `promptName` (enum): Either "generate_table" or "generate_role_and_name"
+  - `baseUrl` (string): The base URL of the page
+  - For generate_role_and_name:
+    - `accessibleName` (string, optional): Accessible name 
+    - `accessibleRole` (string, optional): Accessible role
+
+### 2. available_sentences
+- **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
+
+### 3. generate_role_and_name
+- **Description**: Generate a complete UUV test scenario (Gherkin format) to verify the presence of an element with specified accessible name and role.
+- **Input Schema**:
+  - `baseUrl` (string): The base URL of the page where the element is located
+  - `accessibleName` (string): Accessible name of the element
+  - `accessibleRole` (string): Accessible role of the element
+
+### 4. generate_table
+- **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
+
+## Command
+Add the following command to execute **UUV MCP Server** `npx @uuv/mcp-server`.
+
+### Opencode configuration example (opencode.json)
+```json
+...
+  "mcp": {
+    "playwright": {
+      "type": "local",
+      "enabled": true,
+      "command": [
+        "npx",
+        "@uuv/mcp-server@latest"
+      ]
+    }
+  }
+...
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export * from "./lib/mcp-server";

package/dist/index.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/mcp-server"), exports);

package/dist/lib/mcp-server.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/mcp-server.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
+const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
+const zod_1 = require("zod");
+const sentence_service_1 = require("./services/sentence.service");
+const prompt_retriever_service_1 = require("./services/prompt-retriever.service");
+const expect_service_1 = require("./services/expect.service");
+const dictionary_1 = require("@uuv/dictionary");
+// Create an MCP server
+const server = new mcp_js_1.McpServer({
+    name: "uuv-mcp-server",
+    version: "0.0.1-beta",
+});
+server.registerTool("retrieve_prompt", {
+    title: "Retrieve uuv prompt",
+    description: "Retrieve a uuv prompt template for a coding agent based on a prompt name and arguments.",
+    inputSchema: {
+        promptName: zod_1.z.enum(["generate_table", "generate_role_and_name"]),
+        baseUrl: zod_1.z.string().describe("The base URL of the page"),
+        // generate_role_and_name Fields
+        accessibleName: zod_1.z.string().optional().describe("Accessible name (required for generate_role_and_name)"),
+        accessibleRole: zod_1.z.string().optional().describe("Accessible role (required for generate_role_and_name)")
+    },
+}, async ({ ...args }) => {
+    return {
+        content: [
+            {
+                type: "text",
+                text: prompt_retriever_service_1.PromptRetrieverService.retrievePrompt(args),
+            },
+        ],
+    };
+});
+server.registerTool("available_sentences", {
+    title: "List Available UUV Sentences",
+    description: 
+    // eslint-disable-next-line max-len
+    "List all available UUV test sentences/phrases in Gherkin format. Use this when the user asks about UUV syntax, available commands, what sentences/phrases are available for testing, or needs help with UUV sentence structure. Can be filtered by category (given/when/then) or ARIA role (button, textbox, etc.) to show specific test actions.",
+    inputSchema: {
+        category: zod_1.z
+            .enum(["general", "keyboard", "click", "contains", "type", "checkable"])
+            .optional()
+            .describe("Filters sentences based on the action type"),
+        role: zod_1.z.string().optional().describe("Filters sentences related to an accessible role"),
+    },
+}, async ({ category, role }) => {
+    const sentenceService = new sentence_service_1.SentenceService((0, dictionary_1.getDefinedDictionary)("en"));
+    const allSentences = sentenceService.searchSentences({ category, role });
+    return {
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(allSentences, null, 2),
+            },
+        ],
+    };
+});
+server.registerTool("generate_role_and_name", {
+    title: "Generate with role and name",
+    description: 
+    // eslint-disable-next-line max-len
+    "Generate a complete UUV test scenario (Gherkin format) to verify the presence of an element with specified accessible name and role. Use this when the user asks to create/write/generate a UUV scenario or test for checking element visibility. DON'T USE IF ACCESSIBLE ROLE IS grid, treegrid, table, or form",
+    inputSchema: {
+        baseUrl: zod_1.z.string().describe("The base URL of the page where the element is located."),
+        accessibleName: zod_1.z.string().describe("Accessible name of the element"),
+        accessibleRole: zod_1.z.string().describe("Accessible role of the element"),
+    },
+}, async ({ baseUrl, accessibleName, accessibleRole }) => {
+    if (accessibleRole === "table" || accessibleRole === "grid" || accessibleRole === "treegrid") {
+        throw new Error("For role 'table/grid/treegrid', you must use generateExpectForTable.");
+    }
+    return {
+        content: [
+            {
+                type: "text",
+                text: expect_service_1.ExpectService.generateForAccessibleNameAndRole(baseUrl, accessibleName, accessibleRole),
+            },
+        ],
+    };
+});
+server.registerTool("generate_table", {
+    title: "Generate test for html table or grid or treeGrid",
+    description: 
+    // eslint-disable-next-line max-len
+    "Generate a complete UUV test scenario (Gherkin format) to verify the presence and the content of html table, grid or treegrid given innerHtml. ONLY USE IF ACCESSIBLE ROLE IS grid, treegrid, table, or form",
+    inputSchema: {
+        baseUrl: zod_1.z.string().describe("The base URL of the page where the table/grid/treegrid is located."),
+        innerHtmlFilePath: zod_1.z.string().describe("File path containing the raw innerHTML content of the table, grid, or treegrid element"),
+    },
+}, async ({ baseUrl, innerHtmlFilePath }) => {
+    return {
+        content: [
+            {
+                type: "text",
+                text: await expect_service_1.ExpectService.generateForTable(baseUrl, innerHtmlFilePath),
+            },
+        ],
+    };
+});
+const transport = new stdio_js_1.StdioServerTransport();
+server.connect(transport);

package/dist/lib/services/expect.service.d.ts

@@ -0,0 +1,4 @@
+export declare class ExpectService {
+    static generateForAccessibleNameAndRole(baseUrl: string, accessibleName: string, accessibleRole: string): string;
+    static generateForTable(baseUrl: string, innerHtmlFilePath: string): Promise<string>;
+}

package/dist/lib/services/expect.service.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpectService = void 0;
+const tslib_1 = require("tslib");
+const assistant_1 = require("@uuv/assistant");
+const jsdom_1 = require("jsdom");
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+class ExpectService {
+    static generateForAccessibleNameAndRole(baseUrl, accessibleName, accessibleRole) {
+        const translator = new assistant_1.ExpectTranslator();
+        const result = translator.getSentenceFromAccessibleRoleAndName(accessibleRole, accessibleName);
+        return (0, assistant_1.buildResultingScript)("Your amazing feature name", "Action - An action", result.sentences, baseUrl);
+    }
+    static async generateForTable(baseUrl, innerHtmlFilePath) {
+        const tableAndGridService = new assistant_1.TableAndGridService();
+        const dom = new jsdom_1.JSDOM(node_fs_1.default.readFileSync(innerHtmlFilePath, "utf8"));
+        const element = dom.window.document.body.firstElementChild;
+        const result = await tableAndGridService.buildResultSentence(element);
+        return (0, assistant_1.buildResultingScript)("Your amazing feature name", "Action - Expect Array", result, baseUrl);
+    }
+}
+exports.ExpectService = ExpectService;

package/dist/lib/services/prompt-retriever.service.d.ts

@@ -0,0 +1,12 @@
+type PromptExtraArgs = Record<string, any>;
+export type PromptArgs = {
+    promptName: string;
+} | PromptExtraArgs;
+export declare class PromptRetrieverService {
+    private static loadPromptTemplate;
+    private static renderPrompt;
+    private static generatePrompt;
+    private static validatePromptGenerationRequest;
+    static retrievePrompt(args: PromptArgs): string;
+}
+export {};

package/dist/lib/services/prompt-retriever.service.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptRetrieverService = void 0;
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("node:path"));
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const zod_1 = require("zod");
+class PromptRetrieverService {
+    static loadPromptTemplate(promptName) {
+        const templatePath = path.join(__dirname, "..", "prompts", `${promptName}.mustache`);
+        return node_fs_1.default.readFileSync(templatePath, "utf8");
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static renderPrompt(template, variables) {
+        let result = template;
+        for (const [key, value] of Object.entries(variables)) {
+            if (Array.isArray(value)) {
+                // Handle array values for Mustache-style list rendering
+                const listItems = value.map(item => `{{#${key}}}${item}{{/${key}}}`).join("\n");
+                result = result.replaceAll(`{{#${key}}}`, listItems);
+            }
+            else {
+                result = result.replaceAll(`{{${key}}}`, value);
+            }
+        }
+        return result;
+    }
+    static generatePrompt(args) {
+        const template = this.loadPromptTemplate(args.promptName);
+        return this.renderPrompt(template, args);
+    }
+    static validatePromptGenerationRequest(args) {
+        const promptSchemas = zod_1.z.discriminatedUnion("promptName", [
+            zod_1.z.object({
+                promptName: zod_1.z.literal("generate_table"),
+                baseUrl: zod_1.z.string().describe("The base URL of the page where the table/grid/treegrid is located."),
+            }),
+            zod_1.z.object({
+                promptName: zod_1.z.literal("generate_role_and_name"),
+                baseUrl: zod_1.z.string().describe("The base URL of the page where the element is located."),
+                accessibleName: zod_1.z.string().describe("Accessible name of the element"),
+                accessibleRole: zod_1.z.string().describe("Accessible role of the element"),
+            }),
+        ]);
+        return promptSchemas.parse(args);
+    }
+    static retrievePrompt(args) {
+        const validatedPrompt = PromptRetrieverService.validatePromptGenerationRequest(args);
+        let prompt;
+        switch (validatedPrompt.promptName) {
+            case "generate_table":
+                prompt = PromptRetrieverService.generatePrompt(args);
+                break;
+            case "generate_role_and_name":
+                prompt = PromptRetrieverService.generatePrompt(args);
+                break;
+            default:
+                throw new Error(`Bad parameters for request ${args}`);
+        }
+        return prompt;
+    }
+}
+exports.PromptRetrieverService = PromptRetrieverService;

package/dist/lib/services/sentence.service.d.ts

@@ -0,0 +1,12 @@
+import { Dictionary } from "@uuv/dictionary";
+export type SentenceSearchQuery = {
+    category?: string;
+    role?: string;
+};
+export declare class SentenceService {
+    private dictionary;
+    constructor(dictionary: Dictionary);
+    private getBaseSentences;
+    private getSentencesByRole;
+    searchSentences(query: SentenceSearchQuery): import("@uuv/dictionary").BaseSentence[];
+}

package/dist/lib/services/sentence.service.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentenceService = void 0;
+class SentenceService {
+    dictionary;
+    constructor(dictionary) {
+        this.dictionary = dictionary;
+    }
+    getBaseSentences() {
+        return this.dictionary.getBaseSentences();
+    }
+    getSentencesByRole(role) {
+        return this.dictionary.getRoleBasedSentences().filter(r => !role || r.role === role);
+    }
+    searchSentences(query) {
+        let sentences = [...this.getBaseSentences()];
+        sentences.push(...this.getSentencesByRole(query.role));
+        if (query.category) {
+            sentences = sentences.filter(s => s.section === query.category);
+        }
+        return sentences;
+    }
+}
+exports.SentenceService = SentenceService;

package/dist/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@uuv/mcp-server",
+  "version": "0.0.1",
+  "description": "A Model Context Protocol (MCP) 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.",
+  "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/e2e-test-quest/uuv.git",
+    "directory": "packages/mcp-server"
+  },
+  "keywords": [
+    "uuv",
+    "mcp",
+    "model-context-protocol",
+    "e2e",
+    "end2end",
+    "end 2 end",
+    "test",
+    "testing",
+    "accessibility",
+    "accessibilite",
+    "a11y",
+    "cypress",
+    "playwright",
+    "testing-library",
+    "cucumber",
+    "gherkin",
+    "bdd",
+    "tdd",
+    "acceptance"
+  ],
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "ts-node src/lib/mcp-server.ts",
+    "lint": "npx eslint . --ext .js,.ts,.feature --fix",
+    "tests": "jest --coverage --config=./jest.config.ts"
+  },
+  "bin": {
+    "mcp-server": "./dist/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "1.17.5",
+    "jsdom": "26.1.0",
+    "tsconfig-paths": "4.2.0",
+    "tslib": "2.3.0",
+    "@uuv/dictionary": "0.0.1",
+    "@uuv/assistant": "2.72.0",
+    "zod": "3.25.76"
+  },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/uuv"
+  }
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@uuv/mcp-server",
+  "version": "0.0.1",
+  "description": "A Model Context Protocol (MCP) 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.",
+  "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
+  "license": "MIT",
+  "repository": {
+      "type": "git",
+      "url": "https://github.com/e2e-test-quest/uuv.git",
+      "directory": "packages/mcp-server"
+  },
+  "keywords": [
+    "uuv",
+    "mcp",
+    "model-context-protocol",
+    "e2e",
+    "end2end",
+    "end 2 end",
+    "test",
+    "testing",
+    "accessibility",
+    "accessibilite",
+    "a11y",
+    "cypress",
+    "playwright",
+    "testing-library",
+    "cucumber",
+    "gherkin",
+    "bdd",
+    "tdd",
+    "acceptance"
+  ],
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+      "dist/**/*",
+      "README.md",
+      "LICENSE"
+  ],
+  "scripts": {
+      "start": "ts-node src/lib/mcp-server.ts",
+      "lint": "npx eslint . --ext .js,.ts,.feature --fix",
+      "tests": "jest --coverage --config=./jest.config.ts",
+      "package": "npm pack --pack-destination=\"../../dist/packages\""
+  },
+  "bin": {
+    "mcp-server": "./dist/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "1.17.5",
+    "jsdom": "26.1.0",
+    "tsconfig-paths": "4.2.0",
+    "tslib": "2.3.0",
+    "@uuv/dictionary": "0.0.1",
+    "@uuv/assistant": "2.72.0",
+    "zod": "3.25.76"
+  },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/uuv"
+  }
+}