@provartesting/provardx-cli 1.5.0-beta.6 → 1.5.0-beta.8

package/lib/mcp/licensing/licenseValidator.d.ts

@@ -10,10 +10,10 @@ export interface LicenseValidationResult {
 /**
  * Validate the Provar license before starting the MCP server.
  *
- * Requires Provar Automation IDE to be installed with an activated licence.
+ * Requires Provar Automation IDE to be installed with an activated license.
  * We trust the IDE's own licenseStatus field — if it says "Activated" we
  * accept it. The IDE is responsible for setting licenseStatus to "Expired"
- * or "Invalid" when a licence lapses; we do not re-check timing ourselves.
+ * or "Invalid" when a license lapses; we do not re-check timing ourselves.
  *
  * The result is cached so repeated starts within 2 hours skip the IDE file
  * read entirely. The 48-hour grace window lets the MCP server keep running
@@ -22,7 +22,7 @@ export interface LicenseValidationResult {
  *
  * Validation flow:
  * 1. MCP cache fresh (< 2h) → serve from cache, skip IDE read
- * 2. Scan ~/Provar/.licenses/*.properties for an Activated licence
+ * 2. Scan ~/Provar/.licenses/*.properties for an Activated license
  * 3. Found → write cache, accept (offlineGrace=false)
  * 4. Not found but MCP cache within 48h grace → serve, offlineGrace=true
  * 5. Not found, no usable cache → throw LICENSE_NOT_FOUND

package/lib/mcp/licensing/licenseValidator.js

@@ -16,10 +16,10 @@ const IDE_CACHE_KEY = '__ide_detection__';
 /**
  * Validate the Provar license before starting the MCP server.
  *
- * Requires Provar Automation IDE to be installed with an activated licence.
+ * Requires Provar Automation IDE to be installed with an activated license.
  * We trust the IDE's own licenseStatus field — if it says "Activated" we
  * accept it. The IDE is responsible for setting licenseStatus to "Expired"
- * or "Invalid" when a licence lapses; we do not re-check timing ourselves.
+ * or "Invalid" when a license lapses; we do not re-check timing ourselves.
  *
  * The result is cached so repeated starts within 2 hours skip the IDE file
  * read entirely. The 48-hour grace window lets the MCP server keep running
@@ -28,7 +28,7 @@ const IDE_CACHE_KEY = '__ide_detection__';
  *
  * Validation flow:
  * 1. MCP cache fresh (< 2h) → serve from cache, skip IDE read
- * 2. Scan ~/Provar/.licenses/*.properties for an Activated licence
+ * 2. Scan ~/Provar/.licenses/*.properties for an Activated license
  * 3. Found → write cache, accept (offlineGrace=false)
  * 4. Not found but MCP cache within 48h grace → serve, offlineGrace=true
  * 5. Not found, no usable cache → throw LICENSE_NOT_FOUND
@@ -96,7 +96,7 @@ function validateViaIdeDetection() {
         checkedAt: Date.now(),
     };
     writeCacheEntry(entry);
-    log('info', 'licenseValidator: IDE licence validated and cached', {
+    log('info', 'licenseValidator: IDE license validated and cached', {
         name: ideState.name,
         licenseType: ideState.licenseType,
     });

package/lib/mcp/prompts/index.d.ts

@@ -0,0 +1,2 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export declare function registerAllPrompts(server: McpServer): void;

package/lib/mcp/prompts/index.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { registerCrtMigrationPrompt, registerSeleniumMigrationPrompt, registerPlaywrightMigrationPrompt, } from './migrationPrompts.js';
+import { registerLoopGeneratePrompt, registerLoopFixPrompt, registerLoopReviewPrompt, registerLoopCoveragePrompt, } from './loopPrompts.js';
+export function registerAllPrompts(server) {
+    registerCrtMigrationPrompt(server);
+    registerSeleniumMigrationPrompt(server);
+    registerPlaywrightMigrationPrompt(server);
+    registerLoopGeneratePrompt(server);
+    registerLoopFixPrompt(server);
+    registerLoopReviewPrompt(server);
+    registerLoopCoveragePrompt(server);
+}
+//# sourceMappingURL=index.js.map

package/lib/mcp/prompts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/mcp/prompts/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,iCAAiC,GAClC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,wBAAwB,EACxB,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC;AAE1B,MAAM,UAAU,kBAAkB,CAAC,MAAiB;IAClD,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACnC,+BAA+B,CAAC,MAAM,CAAC,CAAC;IACxC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAC1C,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACnC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC9B,wBAAwB,CAAC,MAAM,CAAC,CAAC;IACjC,0BAA0B,CAAC,MAAM,CAAC,CAAC;AACrC,CAAC"}

package/lib/mcp/prompts/loopPrompts.d.ts

@@ -0,0 +1,5 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export declare function registerLoopGeneratePrompt(server: McpServer): void;
+export declare function registerLoopFixPrompt(server: McpServer): void;
+export declare function registerLoopReviewPrompt(server: McpServer): void;
+export declare function registerLoopCoveragePrompt(server: McpServer): void;

package/lib/mcp/prompts/loopPrompts.js

@@ -0,0 +1,343 @@
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { z } from 'zod';
+// ── Shared helpers ────────────────────────────────────────────────────────────
+function projectHint(projectPath) {
+    return projectPath
+        ? `The Provar project root is: ${projectPath}`
+        : 'Ask the user for the Provar project root path if it is needed for file operations.';
+}
+// ── Prompt: provar.loop.generate ─────────────────────────────────────────────
+export function registerLoopGeneratePrompt(server) {
+    server.prompt('provar.loop.generate', 'Generate a Provar XML test case from a user story or acceptance criteria. Retrieves corpus examples for grounding, generates the test, writes it to the project, then validates it with provar.testcase.validate.', {
+        story: z
+            .string()
+            .describe('The user story or acceptance criteria to test. Paste the full story text, or a numbered list of acceptance criteria. Include the Salesforce object name and the action being tested (e.g. "As a sales rep, I want to close an opportunity so that revenue is recorded").'),
+        projectPath: z
+            .string()
+            .optional()
+            .describe('Absolute path to the Provar project root. Used to locate the tests/ directory when writing the output file.'),
+        testName: z
+            .string()
+            .optional()
+            .describe('Optional name for the output test case file (without extension). Inferred from the story if omitted.'),
+        objectName: z
+            .string()
+            .optional()
+            .describe('Primary Salesforce object under test (e.g. "Opportunity", "Lead"). Helps scope the corpus query if present.'),
+    }, ({ story, projectPath, testName, objectName }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test automation expert. Generate a Provar XML test case from the user story below.
+
+## Workflow
+
+Follow these steps in order:
+
+1. **Extract keywords** — identify the Salesforce object, the action (create/update/close/delete/view), and key
+   scenario details from the story. Use these as the query for step 2.
+
+2. **Get corpus examples** — call \`provar.qualityhub.examples.retrieve\` with the keywords you extracted
+   (e.g. "close opportunity" or "create lead"). Use the returned XML examples as the sole reference for
+   Provar step structure and argument patterns. Do not invent XML structure from prior knowledge.
+   If the response has \`"count": 0\` with a \`"warning"\` field (API unavailable or not configured),
+   fall back: read the \`provar://docs/step-reference\` MCP resource for step types and attribute
+   formats, then continue.
+
+3. **Map acceptance criteria to steps** — for each acceptance criterion, identify the corresponding Provar
+   step type: field fills → UiDoAction (set), button clicks → UiDoAction (action), field checks →
+   UiAssert, API data setup → ApexCreateObject, API verification → ApexReadObject.
+
+4. **Generate the test case** — produce a valid Provar XML test case that tests the story's acceptance
+   criteria. Base the structure entirely on the corpus examples. Follow these rules:
+   - All UI steps must be nested inside UiWithScreen blocks
+   - The first UiWithScreen must use navigate="Always"
+   - UiAssert requires columnAssertions, pageAssertions, resultScope, captureAfter, beforeWait, autoRetry
+   - Use ApexConnect for the connection step (first step in the test)
+   - Wrap test body in TryCatchFinally if cleanup is needed (ApexDeleteObject in the finally clause)
+
+5. **Write the file** — save the XML to the tests/ directory in the Provar project.
+   ${projectHint(projectPath)}
+   ${testName ? `Target file name: ${testName}.testcase` : 'Infer the file name from the story (snake_case).'}
+
+6. **Validate** — call \`provar.testcase.validate\` on the saved file. If it reports errors, fix them
+   and re-validate until the file passes clean.
+
+7. **Report** — summarise:
+   - Which acceptance criteria were covered and how
+   - Any criteria that could not be automated (add \`<!-- TODO: manual verification — <criterion> -->\` in the XML)
+   - Any validation warnings
+
+## User Story
+
+${story}
+
+${objectName ? `Primary object: ${objectName}` : ''}
+
+Begin with step 1: extract keywords, then call provar.qualityhub.examples.retrieve.`,
+                },
+            },
+        ],
+    }));
+}
+// ── Prompt: provar.loop.fix ───────────────────────────────────────────────────
+export function registerLoopFixPrompt(server) {
+    server.prompt('provar.loop.fix', 'Fix a failing Provar test case using the output from provar.testrun.rca. Reads the current XML, retrieves corpus examples for the failing step type, applies targeted fixes, then re-validates.', {
+        testcasePath: z
+            .string()
+            .describe('Absolute path to the failing .testcase XML file. The file must be readable and within the --allowed-paths configured for this MCP server.'),
+        rcaOutput: z
+            .string()
+            .describe('The RCA report text from provar.testrun.rca, or a raw failure message from a test run. Include the full error text — step name, error type, and message. The more detail, the better the fix.'),
+        projectPath: z
+            .string()
+            .optional()
+            .describe('Absolute path to the Provar project root. Used to locate adjacent test files if needed.'),
+    }, ({ testcasePath, rcaOutput, projectPath }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test automation expert. Fix the failing test case at the path below.
+
+## Failing test case
+
+Path: ${testcasePath}
+
+## RCA output
+
+\`\`\`
+${rcaOutput}
+\`\`\`
+
+${projectPath ? `Provar project root: ${projectPath}` : ''}
+
+## Workflow
+
+Follow these steps in order:
+
+1. **Read the failing test case** — read the XML file at the path above using your file reading tools.
+
+2. **Parse the failure** — from the RCA output, identify:
+   - Which step is failing (step name, testItemId, or title)
+   - The failure category (e.g. element not found, assertion mismatch, connection error, XML structure error)
+   - The specific error message
+
+3. **Get corpus examples** — call \`provar.qualityhub.examples.retrieve\` with keywords describing the
+   failing step's scenario (e.g. "close opportunity UiDoAction" or "assert field value UiAssert").
+   Use the returned examples to verify the correct structure for the failing step type.
+   If the response has \`"count": 0\` with a \`"warning"\` field, fall back: read the
+   \`provar://docs/step-reference\` MCP resource for the correct attribute schema for the failing
+   step type, then continue.
+
+4. **Diagnose the root cause** — compare the failing step's XML against the corpus examples. Common issues:
+   - Wrong interaction URI (action vs set vs file)
+   - Missing required UiAssert arguments (columnAssertions, pageAssertions, resultScope, captureAfter, beforeWait, autoRetry)
+   - UiDoAction (set) missing the value argument
+   - UiWithScreen navigate="Dont" on the first screen
+   - navigate="Always" on Edit/View without sfUiTargetObjectId
+   - Incorrect locator URI format
+   - connectionId using valueClass="string" instead of valueClass="id"
+
+5. **Apply the fix** — rewrite only the failing step(s). Preserve all other steps unchanged. Write the
+   updated XML back to the same file path.
+
+6. **Validate** — call \`provar.testcase.validate\` on the updated file. If new errors appear, fix them
+   and re-validate until the file passes clean.
+
+7. **Report** — summarise:
+   - The root cause of the failure
+   - Exactly what was changed (step name, argument changed, before/after values)
+   - Any remaining warnings from validation
+
+Begin with step 1: read the file at: ${testcasePath}`,
+                },
+            },
+        ],
+    }));
+}
+// ── Prompt: provar.loop.review ────────────────────────────────────────────────
+export function registerLoopReviewPrompt(server) {
+    server.prompt('provar.loop.review', 'Review a Provar test case for quality before committing. Runs structural validation, checks against corpus best practices, and reports quality gaps: missing assertions, hardcoded data, missing cleanup, and unmapped steps.', {
+        testcasePath: z
+            .string()
+            .describe('Absolute path to the .testcase XML file to review. Must be within the --allowed-paths configured for this MCP server.'),
+        projectPath: z.string().optional().describe('Absolute path to the Provar project root.'),
+    }, ({ testcasePath, projectPath }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test automation expert. Review the test case at the path below for quality and completeness.
+
+## Test case to review
+
+Path: ${testcasePath}
+${projectPath ? `Provar project root: ${projectPath}` : ''}
+
+## Workflow
+
+Follow these steps in order:
+
+1. **Validate** — call \`provar.testcase.validate\` on the file. Note all errors and warnings. Do not stop
+   here even if the file is valid — continue the review.
+
+2. **Read the file** — read the XML to understand the test structure: what object is being tested, what
+   actions are performed, and what is being asserted.
+
+3. **Get corpus examples** — call \`provar.qualityhub.examples.retrieve\` with keywords describing the
+   test scenario (e.g. "create opportunity", "close opportunity"). Use the returned examples as a
+   quality baseline. If the response has \`"count": 0\` with a \`"warning"\` field, fall back: read
+   the \`provar://docs/step-reference\` MCP resource for step type schemas, then continue the review
+   using that as the quality baseline.
+
+4. **Review for quality gaps** — check for each of the following, noting pass or fail:
+
+   **Coverage**
+   - [ ] Does the test assert the outcome of each action? (e.g. after clicking Save, is there a UiAssert?)
+   - [ ] Are all required fields verified, not just the ones that were set?
+   - [ ] Is there at least one UiAssert or ApexReadObject in the test?
+
+   **Data quality**
+   - [ ] Are test data values parameterised via SetValues rather than hardcoded in multiple steps?
+   - [ ] Are dynamic values (dates, IDs) referenced via variables rather than hardcoded strings?
+
+   **Cleanup**
+   - [ ] Is cleanup handled? Either autoCleanup=true on the connection, or ApexDeleteObject steps, or
+         a TryCatchFinally with cleanup in the finally clause?
+
+   **Structure**
+   - [ ] Does the first UiWithScreen use navigate="Always" or "IfNecessary"?
+   - [ ] Do Edit/View UiWithScreen steps with navigate="Always" include sfUiTargetObjectId?
+   - [ ] Are all UiDoAction and UiAssert steps inside UiWithScreen substeps clauses?
+
+   **Unmapped steps**
+   - [ ] Are there any \`<!-- TODO: -->\` comments indicating steps that couldn't be automated?
+         Flag these for manual review.
+
+5. **Report** — produce a structured review with three sections:
+
+   ### Passes
+   List what the test does well.
+
+   ### Issues
+   For each gap found, state:
+   - What is missing or wrong
+   - Why it matters (e.g. "assertion missing after Save means the test won't catch a silent failure")
+   - A concrete fix (reference the corpus example if relevant)
+
+   ### Suggested improvements
+   Any non-blocking suggestions (e.g. parameterising a hardcoded value that appears more than once).
+
+Begin with step 1: call provar.testcase.validate on the file at: ${testcasePath}`,
+                },
+            },
+        ],
+    }));
+}
+// ── Prompt: provar.loop.coverage ─────────────────────────────────────────────
+export function registerLoopCoveragePrompt(server) {
+    server.prompt('provar.loop.coverage', 'Analyse test coverage for a Salesforce object. Scans the Provar project test files to identify which CRUD operations, field validations, and UI workflows are covered, then reports gaps with suggested test outlines.', {
+        objectName: z
+            .string()
+            .describe('The Salesforce API object name to analyse (e.g. "Opportunity", "Lead", "Contact", "Account"). Used to scan test cases and query the corpus for expected test patterns.'),
+        projectPath: z
+            .string()
+            .describe('Absolute path to the Provar project root. The tests/ subdirectory will be scanned for .testcase files.'),
+        targetOrg: z
+            .string()
+            .optional()
+            .describe('SF org alias or username. If provided, also queries provar.qualityhub.testcase.retrieve to include Quality Hub tests in the coverage analysis.'),
+    }, ({ objectName, projectPath, targetOrg }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test automation expert. Analyse test coverage for the Salesforce object "${objectName}".
+
+## Provar project
+
+Root: ${projectPath}
+Object to analyse: ${objectName}
+${targetOrg ? `Quality Hub org: ${targetOrg}` : ''}
+
+## Workflow
+
+Follow these steps in order:
+
+1. **Scan local test files** — list all .testcase files under ${projectPath}/tests/. For each file that
+   references "${objectName}" (search for the string in the file content), read it and extract:
+   - The test scenario (from the file name or meta comment)
+   - Which operations are covered: API Create, API Read, API Update, API Delete, UI New, UI View,
+     UI Edit, UI Delete, UI assertions on fields
+   - Which fields are set or asserted
+
+${targetOrg
+                        ? `2. **Query Quality Hub** — call \`provar.qualityhub.testcase.retrieve\` with target_org="${targetOrg}"
+   to retrieve test cases linked to the "${objectName}" object from Quality Hub. Add these to the
+   coverage inventory.
+
+3. **Get corpus examples** — call \`provar.qualityhub.examples.retrieve\` with "${objectName.toLowerCase()}"
+   as the query to understand what test patterns exist in the corpus for this object.
+   If the response has \`"count": 0\` with a \`"warning"\` field, fall back: read the
+   \`provar://docs/step-reference\` MCP resource for step type schemas, then continue.`
+                        : `2. **Get corpus examples** — call \`provar.qualityhub.examples.retrieve\` with "${objectName.toLowerCase()}"
+   as the query to understand what test patterns exist in the corpus for this object.
+   If the response has \`"count": 0\` with a \`"warning"\` field, fall back: read the
+   \`provar://docs/step-reference\` MCP resource for step type schemas, then continue.`}
+
+${targetOrg ? '4' : '3'}. **Build the coverage matrix** — define the standard test scenarios for "${objectName}":
+
+   **API (Apex) operations**
+   - Create: ApexCreateObject with required fields
+   - Create: ApexCreateObject with optional/edge-case fields
+   - Read: ApexReadObject — verify created record
+   - Update: ApexUpdateObject — modify field values
+   - Delete: ApexDeleteObject — confirm record removed
+   - SOQL: ApexSoqlQuery — query by key fields
+
+   **UI operations**
+   - New: navigate to New screen, fill required fields, save → assert record created
+   - View: navigate to View screen → assert field values
+   - Edit: navigate to Edit screen, modify fields, save → assert changes persisted
+   - Delete: delete via UI → confirm record no longer visible
+   - Related lists: any relationships (e.g. Contacts on Account) that have UI tests
+
+   **Validation rules and required fields**
+   - Negative tests: attempt to save with missing required fields → assert error message shown
+   - Validation rule triggers: if known validation rules exist, is there a test for each?
+
+${targetOrg ? '5' : '4'}. **Report coverage gaps** — produce a report with three sections:
+
+   ### Covered
+   List each scenario that has at least one test, with the test file name.
+
+   ### Gaps
+   For each missing scenario, state:
+   - What is not covered
+   - Why it matters (e.g. "No negative test for required fields means validation rule regressions won't be caught")
+   - A brief test outline (inputs, expected outcome, which step types to use)
+
+   ### Suggested next tests
+   Rank the top 3-5 gaps by risk. For each, provide:
+   - A suggested test case name
+   - The key steps (using correct Provar step type names from the reference)
+   - Estimated effort (XS / S / M)
+
+Begin with step 1: list the .testcase files in ${projectPath}/tests/ and search for "${objectName}".`,
+                },
+            },
+        ],
+    }));
+}
+//# sourceMappingURL=loopPrompts.js.map

package/lib/mcp/prompts/loopPrompts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loopPrompts.js","sourceRoot":"","sources":["../../../src/mcp/prompts/loopPrompts.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,iFAAiF;AAEjF,SAAS,WAAW,CAAC,WAA+B;IAClD,OAAO,WAAW;QAChB,CAAC,CAAC,+BAA+B,WAAW,EAAE;QAC9C,CAAC,CAAC,oFAAoF,CAAC;AAC3F,CAAC;AAED,gFAAgF;AAEhF,MAAM,UAAU,0BAA0B,CAAC,MAAiB;IAC1D,MAAM,CAAC,MAAM,CACX,sBAAsB,EACtB,mNAAmN,EACnN;QACE,KAAK,EAAE,CAAC;aACL,MAAM,EAAE;aACR,QAAQ,CACP,0QAA0Q,CAC3Q;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6GAA6G,CAC9G;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,sGAAsG,CACvG;QACH,UAAU,EAAE,CAAC;aACV,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6GAA6G,CAC9G;KACJ,EACD,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA6Bb,WAAW,CAAC,WAAW,CAAC;KACxB,QAAQ,CAAC,CAAC,CAAC,qBAAqB,QAAQ,WAAW,CAAC,CAAC,CAAC,kDAAkD;;;;;;;;;;;;EAY3G,KAAK;;EAEL,UAAU,CAAC,CAAC,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE;;oFAEiC;iBACzE;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,iFAAiF;AAEjF,MAAM,UAAU,qBAAqB,CAAC,MAAiB;IACrD,MAAM,CAAC,MAAM,CACX,iBAAiB,EACjB,iMAAiM,EACjM;QACE,YAAY,EAAE,CAAC;aACZ,MAAM,EAAE;aACR,QAAQ,CACP,2IAA2I,CAC5I;QACH,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,QAAQ,CACP,+LAA+L,CAChM;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,yFAAyF,CAAC;KACvG,EACD,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QAC7C,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;QAIV,YAAY;;;;;EAKlB,SAAS;;;EAGT,WAAW,CAAC,CAAC,CAAC,wBAAwB,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uCAwCnB,YAAY,EAAE;iBAC1C;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,iFAAiF;AAEjF,MAAM,UAAU,wBAAwB,CAAC,MAAiB;IACxD,MAAM,CAAC,MAAM,CACX,oBAAoB,EACpB,+NAA+N,EAC/N;QACE,YAAY,EAAE,CAAC;aACZ,MAAM,EAAE;aACR,QAAQ,CACP,uHAAuH,CACxH;QACH,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2CAA2C,CAAC;KACzF,EACD,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;QAIV,YAAY;EAClB,WAAW,CAAC,CAAC,CAAC,wBAAwB,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mEAwDS,YAAY,EAAE;iBACtE;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,gFAAgF;AAEhF,MAAM,UAAU,0BAA0B,CAAC,MAAiB;IAC1D,MAAM,CAAC,MAAM,CACX,sBAAsB,EACtB,wNAAwN,EACxN;QACE,UAAU,EAAE,CAAC;aACV,MAAM,EAAE;aACR,QAAQ,CACP,wKAAwK,CACzK;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,CACP,wGAAwG,CACzG;QACH,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,gJAAgJ,CACjJ;KACJ,EACD,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3C,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,6FAA6F,UAAU;;;;QAIjH,WAAW;qBACE,UAAU;EAC7B,SAAS,CAAC,CAAC,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE;;;;;;gEAMc,WAAW;iBAC1D,UAAU;;;;;;EAOzB,SAAS;wBACP,CAAC,CAAC,4FAA4F,SAAS;2CAChE,UAAU;;;kFAG6B,UAAU,CAAC,WAAW,EAAE;;;uFAGnB;wBACnF,CAAC,CAAC,mFAAmF,UAAU,CAAC,WAAW,EAAE;;;uFAIjH;;EAEE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,6EAA6E,UAAU;;;;;;;;;;;;;;;;;;;;;EAqB5G,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;;;;;;;;;;;;;;;;;iDAiB0B,WAAW,2BAA2B,UAAU,IAAI;iBAC1F;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC"}

package/lib/mcp/prompts/migrationPrompts.d.ts

@@ -0,0 +1,4 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export declare function registerCrtMigrationPrompt(server: McpServer): void;
+export declare function registerSeleniumMigrationPrompt(server: McpServer): void;
+export declare function registerPlaywrightMigrationPrompt(server: McpServer): void;

package/lib/mcp/prompts/migrationPrompts.js

@@ -0,0 +1,207 @@
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { z } from 'zod';
+// Source-framework context injected into each migration prompt.
+// Lightweight: just enough to interpret the source. Format knowledge lives
+// in the corpus (provar.qualityhub.examples.retrieve) and the validator
+// (provar.testcase.validate) — not hardcoded here.
+const CRT_CONTEXT = `
+CRT (Copado Robotic Testing) is a keyword-driven framework built on Robot Framework.
+Tests are authored in QEditor using QWords:
+- ClickText <label>         → click an element by visible label
+- TypeText <field> <value>  → type a value into a field
+- VerifyText <text>         → assert text is present on the page
+- SelectDropdown <field> <val> → choose a picklist option
+- OpenBrowser <url>         → open a browser session (maps to Salesforce login)
+
+Robot Framework sections: *** Keywords *** define reusable blocks; *** Test Cases *** are the test entries.
+Suite Setup/Teardown → login at the start and cleanup at the end.
+`.trim();
+const SELENIUM_CONTEXT = `
+Selenium WebDriver test patterns (Java/Python/JavaScript):
+- driver.get(url) / navigate().to() → navigate to a URL (maps to Salesforce login)
+- findElement(By.linkText/name).click() → click by visible label
+- findElement(...).sendKeys(value) → type into a field
+- Select.selectByVisibleText(val) → select a picklist option
+- findElement(...).getText() + assertion → verify a field value
+- WebDriverWait / ExpectedConditions → wait for element visibility
+- @Before / setUp() → test setup including login
+- @After / tearDown() → cleanup
+`.trim();
+const PLAYWRIGHT_CONTEXT = `
+Playwright test patterns (TypeScript/JavaScript):
+- page.goto(url) / login fixture → navigate to Salesforce (maps to login)
+- getByLabel(label).click() → click by visible label
+- getByRole('button', {name}).click() → click by button name
+- getByLabel(label).fill(value) → fill a field by label
+- locator(selector).fill(value) → fill by XPath/CSS selector
+- locator.selectOption(value) → choose a picklist option
+- expect(locator).toHaveValue(val) → assert a field value
+- expect(locator).toBeVisible() → assert element is visible
+- expect(page).toContainText(text) → assert text on page
+- page.waitForLoadState() / waitForSelector() → wait conditions
+- beforeEach → test setup including login
+`.trim();
+// ── Shared orchestration instructions ────────────────────────────────────────
+function migrationOrchestration(projectPath) {
+    const projectHint = projectPath
+        ? `The target Provar project is at: ${projectPath}`
+        : 'Ask the user for the Provar project path if needed.';
+    return `
+## Migration workflow
+
+Follow these steps in order:
+
+1. **Get corpus examples** — call \`provar.qualityhub.examples.retrieve\` with keywords that
+   describe the source test's main scenario (e.g. "create opportunity", "close case", "convert lead").
+   Use the returned examples as few-shot grounding for the Provar XML format and step patterns.
+   If the response has \`"count": 0\` with a \`"warning"\` field (API unavailable or not configured),
+   fall back: read the \`provar://docs/step-reference\` MCP resource for step types and attribute
+   formats, then continue with generation based on that reference.
+
+2. **Generate the test case** — produce a valid Provar XML test case that faithfully captures
+   the intent of the source test. Base the structure entirely on the corpus examples, not on
+   prior knowledge of Provar XML. Omit Salesforce login/navigation setup — Provar handles
+   that via Connection Manager.
+
+3. **Write the file** — save the generated XML to the appropriate \`tests/\` subdirectory
+   inside the Provar project. ${projectHint}
+
+4. **Validate** — call \`provar.testcase.validate\` on the saved file. If it reports errors,
+   fix them and re-validate until the file passes clean.
+
+5. **Report** — summarise what was migrated, any steps that could not be mapped (add them
+   as \`<!-- TODO: manual step -->\` comments in the XML), and any validation warnings.
+`.trim();
+}
+// ── Prompt: provar.migrate.crt ────────────────────────────────────────────────
+export function registerCrtMigrationPrompt(server) {
+    server.prompt('provar.migrate.crt', 'Convert a Copado Robotic Testing (CRT) test — either a QWord step sequence or a Robot Framework .robot file — into a Provar XML test case. Retrieves corpus examples for grounding, generates the test case, then validates it with provar.testcase.validate.', {
+        source: z
+            .string()
+            .describe('The CRT test content to migrate. Accepts either: (1) a numbered QWord step sequence (e.g. "Step 1: ClickText Accounts"), or (2) a Robot Framework .robot file with *** Settings ***, *** Keywords ***, and *** Test Cases *** sections.'),
+        projectPath: z
+            .string()
+            .optional()
+            .describe('Absolute path to the Provar project root. Used to locate the tests/ directory when writing the output file.'),
+        testName: z
+            .string()
+            .optional()
+            .describe('Optional name for the output Provar test case. Inferred from the source if omitted.'),
+    }, ({ source, projectPath, testName }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test migration expert. Migrate the following CRT test to Provar.
+
+## Source format — CRT
+
+${CRT_CONTEXT}
+
+${migrationOrchestration(projectPath)}
+
+## Source CRT Test
+
+\`\`\`
+${source}
+\`\`\`
+
+${testName ? `Target test case name: ${testName}` : 'Infer the test case name from the source content.'}
+
+Begin with step 1: call provar.qualityhub.examples.retrieve.`,
+                },
+            },
+        ],
+    }));
+}
+// ── Prompt: provar.migrate.selenium ──────────────────────────────────────────
+export function registerSeleniumMigrationPrompt(server) {
+    server.prompt('provar.migrate.selenium', 'Convert a Selenium WebDriver test (Java, Python, or JavaScript) that tests a Salesforce org into a Provar XML test case. Retrieves corpus examples for grounding, generates the test case, then validates it with provar.testcase.validate.', {
+        source: z
+            .string()
+            .describe('The Selenium test file content to migrate. Accepts Java (JUnit/TestNG), Python (unittest/pytest), or JavaScript (Jest/Mocha) with selenium-webdriver. Include the full file or the relevant test method(s).'),
+        projectPath: z
+            .string()
+            .optional()
+            .describe('Absolute path to the Provar project root. Used to locate the tests/ directory when writing the output file.'),
+        testName: z
+            .string()
+            .optional()
+            .describe('Optional name for the output Provar test case. Inferred from the source class/method name if omitted.'),
+    }, ({ source, projectPath, testName }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test migration expert. Migrate the following Selenium WebDriver test to Provar.
+
+## Source format — Selenium WebDriver
+
+${SELENIUM_CONTEXT}
+
+${migrationOrchestration(projectPath)}
+
+## Source Selenium Test
+
+\`\`\`
+${source}
+\`\`\`
+
+${testName ? `Target test case name: ${testName}` : 'Infer the test case name from the class and method name.'}
+
+Begin with step 1: call provar.qualityhub.examples.retrieve.`,
+                },
+            },
+        ],
+    }));
+}
+// ── Prompt: provar.migrate.playwright ────────────────────────────────────────
+export function registerPlaywrightMigrationPrompt(server) {
+    server.prompt('provar.migrate.playwright', 'Convert a Playwright test (TypeScript or JavaScript) that tests a Salesforce org into a Provar XML test case. Retrieves corpus examples for grounding, generates the test case, then validates it with provar.testcase.validate.', {
+        source: z
+            .string()
+            .describe('The Playwright test file content to migrate. Accepts TypeScript or JavaScript using @playwright/test or the playwright library. Include the full file or the relevant test block(s).'),
+        projectPath: z
+            .string()
+            .optional()
+            .describe('Absolute path to the Provar project root. Used to locate the tests/ directory when writing the output file.'),
+        testName: z
+            .string()
+            .optional()
+            .describe('Optional name for the output Provar test case. Inferred from the test() block description if omitted.'),
+    }, ({ source, projectPath, testName }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test migration expert. Migrate the following Playwright test to Provar.
+
+## Source format — Playwright
+
+${PLAYWRIGHT_CONTEXT}
+
+${migrationOrchestration(projectPath)}
+
+## Source Playwright Test
+
+\`\`\`
+${source}
+\`\`\`
+
+${testName ? `Target test case name: ${testName}` : 'Infer the test case name from the test() block description.'}
+
+Begin with step 1: call provar.qualityhub.examples.retrieve.`,
+                },
+            },
+        ],
+    }));
+}
+//# sourceMappingURL=migrationPrompts.js.map

package/lib/mcp/prompts/migrationPrompts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrationPrompts.js","sourceRoot":"","sources":["../../../src/mcp/prompts/migrationPrompts.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,gEAAgE;AAChE,2EAA2E;AAC3E,wEAAwE;AACxE,mDAAmD;AAEnD,MAAM,WAAW,GAAG;;;;;;;;;;;CAWnB,CAAC,IAAI,EAAE,CAAC;AAET,MAAM,gBAAgB,GAAG;;;;;;;;;;CAUxB,CAAC,IAAI,EAAE,CAAC;AAET,MAAM,kBAAkB,GAAG;;;;;;;;;;;;;CAa1B,CAAC,IAAI,EAAE,CAAC;AAET,gFAAgF;AAEhF,SAAS,sBAAsB,CAAC,WAA+B;IAC7D,MAAM,WAAW,GAAG,WAAW;QAC7B,CAAC,CAAC,oCAAoC,WAAW,EAAE;QACnD,CAAC,CAAC,qDAAqD,CAAC;IAE1D,OAAO;;;;;;;;;;;;;;;;;;gCAkBuB,WAAW;;;;;;;CAO1C,CAAC,IAAI,EAAE,CAAC;AACT,CAAC;AAED,iFAAiF;AAEjF,MAAM,UAAU,0BAA0B,CAAC,MAAiB;IAC1D,MAAM,CAAC,MAAM,CACX,oBAAoB,EACpB,+PAA+P,EAC/P;QACE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,CACP,yOAAyO,CAC1O;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6GAA6G,CAC9G;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,qFAAqF,CAAC;KACnG,EACD,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;EAIhB,WAAW;;EAEX,sBAAsB,CAAC,WAAW,CAAC;;;;;EAKnC,MAAM;;;EAGN,QAAQ,CAAC,CAAC,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC,CAAC,mDAAmD;;6DAE1C;iBAClD;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,gFAAgF;AAEhF,MAAM,UAAU,+BAA+B,CAAC,MAAiB;IAC/D,MAAM,CAAC,MAAM,CACX,yBAAyB,EACzB,6OAA6O,EAC7O;QACE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,CACP,6MAA6M,CAC9M;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6GAA6G,CAC9G;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,uGAAuG,CACxG;KACJ,EACD,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;EAIhB,gBAAgB;;EAEhB,sBAAsB,CAAC,WAAW,CAAC;;;;;EAKnC,MAAM;;;EAGN,QAAQ,CAAC,CAAC,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC,CAAC,0DAA0D;;6DAEjD;iBAClD;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,gFAAgF;AAEhF,MAAM,UAAU,iCAAiC,CAAC,MAAiB;IACjE,MAAM,CAAC,MAAM,CACX,2BAA2B,EAC3B,kOAAkO,EAClO;QACE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,CACP,sLAAsL,CACvL;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6GAA6G,CAC9G;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,uGAAuG,CACxG;KACJ,EACD,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;EAIhB,kBAAkB;;EAElB,sBAAsB,CAAC,WAAW,CAAC;;;;;EAKnC,MAAM;;;EAGN,QAAQ,CAAC,CAAC,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC,CAAC,6DAA6D;;6DAEpD;iBAClD;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC"}