@checkview/mcp-server 1.1.0

package/dist/tools/create-form-test-flow.js

@@ -0,0 +1,228 @@
+import { z } from "zod";
+import { ApiError, idempotencyKey } from "../api-client.js";
+import { pollUntil } from "../polling.js";
+export function registerCreateFormTestFlowTool(server, client) {
+    server.registerTool("checkview_create_form_test_flow", {
+        description: "Create a WordPress form test flow using the progressive scanner. Requires the CheckView WordPress plugin installed on the target site. The scanner detects form fields and auto-generates steps. Use checkview_list_forms first to discover available forms and get the required form_id, plugin_id, page_url, and page_id values. For WooCommerce checkout or other non-form tests, use checkview_test_url instead.",
+        inputSchema: {
+            website_id: z
+                .string()
+                .uuid()
+                .describe("Website ID (from checkview_list_websites)"),
+            name: z.string().min(1).max(255).describe("Test flow name"),
+            page_url: z
+                .string()
+                .url()
+                .describe("Full URL of the page containing the form (e.g. https://example.com/contact)"),
+            plugin_id: z
+                .enum([
+                "gravityforms",
+                "wpforms",
+                "fluentforms",
+                "wsforms",
+                "formidable",
+                "cf7",
+                "ninjaforms",
+            ])
+                .describe('WordPress form plugin slug. Supported: "wpforms", "gravityforms", "fluentforms", "wsforms", "formidable", "cf7" (Contact Form 7), "ninjaforms"'),
+            form_id: z
+                .string()
+                .describe('The form ID within the plugin (e.g. "1", "42")'),
+            page_id: z
+                .string()
+                .describe('WordPress page ID where the form appears (e.g. "123")'),
+            device_type: z
+                .enum(["inherit", "desktop", "mobile"])
+                .optional()
+                .default("desktop")
+                .describe("Device type for test execution (default: desktop)"),
+            disable_actions: z
+                .boolean()
+                .optional()
+                .describe("Disable supported form add-on integrations (webhooks, CRM feeds, Zapier, etc.) during tests when possible. Omit to inherit the organization default (false / integrations fire)."),
+            wait_for_steps: z
+                .boolean()
+                .optional()
+                .default(true)
+                .describe("Wait for the progressive scanner to finish generating steps (default: true). If false, returns immediately after creation."),
+        },
+        annotations: {
+            readOnlyHint: false,
+            destructiveHint: false,
+            idempotentHint: true,
+        },
+    }, async (args, extra) => {
+        try {
+            const idemKey = idempotencyKey(`create-form-flow:${args.website_id}:${args.plugin_id}:${args.form_id}:${args.page_url}`);
+            await server.sendLoggingMessage({
+                level: "info",
+                data: `Creating form test flow "${args.name}" for ${args.plugin_id} form #${args.form_id}...`,
+            });
+            // Create the test flow with form type + WordPress parameters
+            // Field names must match FormTestFlowParamsSchema (wordpressFormId, wordpressPageId)
+            const parameters = {
+                pageUrl: args.page_url,
+                pluginId: args.plugin_id,
+                wordpressFormId: args.form_id,
+                wordpressPageId: args.page_id,
+            };
+            let testFlow;
+            try {
+                const result = await client.post("/test-flows", {
+                    name: args.name,
+                    type: "form",
+                    parameters,
+                    websiteId: args.website_id,
+                    deviceType: args.device_type ?? "desktop",
+                    ...(args.disable_actions !== undefined && {
+                        disableActions: args.disable_actions ? "yes" : "no",
+                    }),
+                    generateSteps: true,
+                }, idemKey, extra.signal);
+                testFlow = result.body;
+            }
+            catch (error) {
+                if (error instanceof ApiError) {
+                    if (error.isReplay && error.status >= 400) {
+                        const freshKey = idempotencyKey(`create-form-flow:${args.website_id}:${args.plugin_id}:${args.form_id}:retry:${Date.now()}`);
+                        const retryResult = await client.post("/test-flows", {
+                            name: args.name,
+                            type: "form",
+                            parameters,
+                            websiteId: args.website_id,
+                            deviceType: args.device_type ?? "desktop",
+                            generateSteps: true,
+                        }, freshKey, extra.signal);
+                        testFlow = retryResult.body;
+                    }
+                    else {
+                        return {
+                            content: [
+                                {
+                                    type: "text",
+                                    text: `Failed to create form test flow: ${error.detail}`,
+                                },
+                            ],
+                            isError: true,
+                        };
+                    }
+                }
+                else {
+                    throw error;
+                }
+            }
+            const testFlowId = testFlow.id;
+            // If not waiting for steps, return immediately
+            if (!args.wait_for_steps) {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: `Form test flow created: "${args.name}"\n\nTest flow ID: ${testFlowId}\nPlugin: ${args.plugin_id}\nForm ID: ${args.form_id}\nStep generation: in progress\n\nUse checkview_get_test_flow("${testFlowId}") to check progress.`,
+                        },
+                    ],
+                };
+            }
+            // Poll for step generation to complete
+            await server.sendLoggingMessage({
+                level: "info",
+                data: `Test flow ${testFlowId} created. Waiting for progressive scanner to generate steps...`,
+            });
+            let lastDetail = {
+                id: testFlowId,
+                name: args.name,
+                status: "created",
+            };
+            let finalDetail;
+            try {
+                finalDetail = await pollUntil(async () => {
+                    try {
+                        const r = await client.get(`/test-flows/${testFlowId}`, undefined, extra.signal);
+                        lastDetail = r.body;
+                        return r.body;
+                    }
+                    catch (error) {
+                        if (error instanceof ApiError && error.status >= 500) {
+                            return lastDetail;
+                        }
+                        throw error;
+                    }
+                }, (detail) => {
+                    // Done when steps exist with a post-init status, or status indicates failure
+                    const hasSteps = (detail.steps?.length ?? 0) > 0;
+                    const isTerminal = hasSteps && !["waiting_init", "init"].includes(detail.status);
+                    const isFailed = detail.status === "init_failed" ||
+                        detail.status === "init_failed_fatal" ||
+                        detail.status === "init_aborted";
+                    return isTerminal || isFailed;
+                }, {
+                    intervalMs: 5_000,
+                    timeoutMs: 180_000, // 3 min
+                    signal: extra.signal,
+                    onProgress: (detail) => {
+                        const stepCount = detail.steps?.length ?? 0;
+                        server
+                            .sendLoggingMessage({
+                            level: "info",
+                            data: `Test flow ${testFlowId}: status=${detail.status}, steps=${stepCount}`,
+                        })
+                            .catch(() => { });
+                    },
+                });
+            }
+            catch (error) {
+                const isTimeout = error instanceof Error &&
+                    error.message.startsWith("Operation timed out");
+                if (isTimeout) {
+                    return {
+                        content: [
+                            {
+                                type: "text",
+                                text: `Form test flow created but step generation is still in progress after 3 min.\n\nTest flow ID: ${testFlowId}\nStatus: ${lastDetail.status}\n\nUse checkview_get_test_flow("${testFlowId}") to check later.`,
+                            },
+                        ],
+                    };
+                }
+                throw error;
+            }
+            // Check result
+            if (finalDetail.status === "init_failed" ||
+                finalDetail.status === "init_failed_fatal" ||
+                finalDetail.status === "init_aborted") {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: `Form test flow created but step generation failed.\n\nTest flow ID: ${testFlowId}\nStatus: ${finalDetail.status}\n\nThis usually means the CheckView plugin is not installed, the form was not found, or the site is unreachable. Check the website's WordPress plugin status.`,
+                        },
+                    ],
+                    isError: true,
+                };
+            }
+            const steps = finalDetail.steps ?? [];
+            const stepsSummary = steps
+                .map((s) => `${s.index + 1}. ${s.type}`)
+                .join("\n");
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Form test flow created: "${args.name}"\n\nTest flow ID: ${testFlowId}\nPlugin: ${args.plugin_id}\nForm ID: ${args.form_id}\nSteps generated: ${steps.length}\n\n### Steps\n${stepsSummary}\n\nUse checkview_run_test("${testFlowId}") to execute it.`,
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Failed to create form test flow: ${error instanceof Error ? error.message : String(error)}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    });
+}
+//# sourceMappingURL=create-form-test-flow.js.map

package/dist/tools/create-form-test-flow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-form-test-flow.js","sourceRoot":"","sources":["../../src/tools/create-form-test-flow.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAkB,MAAM,kBAAkB,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAoB1C,MAAM,UAAU,8BAA8B,CAC5C,MAAiB,EACjB,MAAiB;IAEjB,MAAM,CAAC,YAAY,CACjB,iCAAiC,EACjC;QACE,WAAW,EACT,sZAAsZ;QACxZ,WAAW,EAAE;YACX,UAAU,EAAE,CAAC;iBACV,MAAM,EAAE;iBACR,IAAI,EAAE;iBACN,QAAQ,CAAC,2CAA2C,CAAC;YACxD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAC3D,QAAQ,EAAE,CAAC;iBACR,MAAM,EAAE;iBACR,GAAG,EAAE;iBACL,QAAQ,CACP,6EAA6E,CAC9E;YACH,SAAS,EAAE,CAAC;iBACT,IAAI,CAAC;gBACJ,cAAc;gBACd,SAAS;gBACT,aAAa;gBACb,SAAS;gBACT,YAAY;gBACZ,KAAK;gBACL,YAAY;aACb,CAAC;iBACD,QAAQ,CACP,gJAAgJ,CACjJ;YACH,OAAO,EAAE,CAAC;iBACP,MAAM,EAAE;iBACR,QAAQ,CAAC,gDAAgD,CAAC;YAC7D,OAAO,EAAE,CAAC;iBACP,MAAM,EAAE;iBACR,QAAQ,CAAC,uDAAuD,CAAC;YACpE,WAAW,EAAE,CAAC;iBACX,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;iBACtC,QAAQ,EAAE;iBACV,OAAO,CAAC,SAAS,CAAC;iBAClB,QAAQ,CAAC,mDAAmD,CAAC;YAChE,eAAe,EAAE,CAAC;iBACf,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CACP,kLAAkL,CACnL;YACH,cAAc,EAAE,CAAC;iBACd,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,OAAO,CAAC,IAAI,CAAC;iBACb,QAAQ,CACP,4HAA4H,CAC7H;SACJ;QACD,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;SACrB;KACF,EACD,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;QACpB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,cAAc,CAC5B,oBAAoB,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CACzF,CAAC;YAEF,MAAM,MAAM,CAAC,kBAAkB,CAAC;gBAC9B,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,4BAA4B,IAAI,CAAC,IAAI,SAAS,IAAI,CAAC,SAAS,UAAU,IAAI,CAAC,OAAO,KAAK;aAC9F,CAAC,CAAC;YAEH,6DAA6D;YAC7D,qFAAqF;YACrF,MAAM,UAAU,GAA4B;gBAC1C,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACxB,eAAe,EAAE,IAAI,CAAC,OAAO;gBAC7B,eAAe,EAAE,IAAI,CAAC,OAAO;aAC9B,CAAC;YAEF,IAAI,QAAgC,CAAC;YACrC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAC9B,aAAa,EACb;oBACE,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,IAAI,EAAE,MAAM;oBACZ,UAAU;oBACV,SAAS,EAAE,IAAI,CAAC,UAAU;oBAC1B,UAAU,EAAE,IAAI,CAAC,WAAW,IAAI,SAAS;oBACzC,GAAG,CAAC,IAAI,CAAC,eAAe,KAAK,SAAS,IAAI;wBACxC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;qBACpD,CAAC;oBACF,aAAa,EAAE,IAAI;iBACpB,EACD,OAAO,EACP,KAAK,CAAC,MAAM,CACb,CAAC;gBACF,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;YACzB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;oBAC9B,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;wBAC1C,MAAM,QAAQ,GAAG,cAAc,CAC7B,oBAAoB,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,UAAU,IAAI,CAAC,GAAG,EAAE,EAAE,CAC5F,CAAC;wBACF,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,IAAI,CACnC,aAAa,EACb;4BACE,IAAI,EAAE,IAAI,CAAC,IAAI;4BACf,IAAI,EAAE,MAAM;4BACZ,UAAU;4BACV,SAAS,EAAE,IAAI,CAAC,UAAU;4BAC1B,UAAU,EAAE,IAAI,CAAC,WAAW,IAAI,SAAS;4BACzC,aAAa,EAAE,IAAI;yBACpB,EACD,QAAQ,EACR,KAAK,CAAC,MAAM,CACb,CAAC;wBACF,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC;oBAC9B,CAAC;yBAAM,CAAC;wBACN,OAAO;4BACL,OAAO,EAAE;gCACP;oCACE,IAAI,EAAE,MAAM;oCACZ,IAAI,EAAE,oCAAoC,KAAK,CAAC,MAAM,EAAE;iCACzD;6BACF;4BACD,OAAO,EAAE,IAAI;yBACd,CAAC;oBACJ,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;YAED,MAAM,UAAU,GAAG,QAAQ,CAAC,EAAE,CAAC;YAE/B,+CAA+C;YAC/C,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,4BAA4B,IAAI,CAAC,IAAI,sBAAsB,UAAU,aAAa,IAAI,CAAC,SAAS,cAAc,IAAI,CAAC,OAAO,kEAAkE,UAAU,uBAAuB;yBACpO;qBACF;iBACF,CAAC;YACJ,CAAC;YAED,uCAAuC;YACvC,MAAM,MAAM,CAAC,kBAAkB,CAAC;gBAC9B,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,aAAa,UAAU,gEAAgE;aAC9F,CAAC,CAAC;YAEH,IAAI,UAAU,GAAmB;gBAC/B,EAAE,EAAE,UAAU;gBACd,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,SAAS;aAClB,CAAC;YACF,IAAI,WAA2B,CAAC;YAChC,IAAI,CAAC;gBACH,WAAW,GAAG,MAAM,SAAS,CAC3B,KAAK,IAAI,EAAE;oBACT,IAAI,CAAC;wBACH,MAAM,CAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CACxB,eAAe,UAAU,EAAE,EAC3B,SAAS,EACT,KAAK,CAAC,MAAM,CACb,CAAC;wBACF,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC;wBACpB,OAAO,CAAC,CAAC,IAAI,CAAC;oBAChB,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,IAAI,KAAK,YAAY,QAAQ,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;4BACrD,OAAO,UAAU,CAAC;wBACpB,CAAC;wBACD,MAAM,KAAK,CAAC;oBACd,CAAC;gBACH,CAAC,EACD,CAAC,MAAM,EAAE,EAAE;oBACT,6EAA6E;oBAC7E,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;oBACjD,MAAM,UAAU,GACd,QAAQ,IAAI,CAAC,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAChE,MAAM,QAAQ,GACZ,MAAM,CAAC,MAAM,KAAK,aAAa;wBAC/B,MAAM,CAAC,MAAM,KAAK,mBAAmB;wBACrC,MAAM,CAAC,MAAM,KAAK,cAAc,CAAC;oBACnC,OAAO,UAAU,IAAI,QAAQ,CAAC;gBAChC,CAAC,EACD;oBACE,UAAU,EAAE,KAAK;oBACjB,SAAS,EAAE,OAAO,EAAE,QAAQ;oBAC5B,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE;wBACrB,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC;wBAC5C,MAAM;6BACH,kBAAkB,CAAC;4BAClB,KAAK,EAAE,MAAM;4BACb,IAAI,EAAE,aAAa,UAAU,YAAY,MAAM,CAAC,MAAM,WAAW,SAAS,EAAE;yBAC7E,CAAC;6BACD,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;oBACrB,CAAC;iBACF,CACF,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,SAAS,GACb,KAAK,YAAY,KAAK;oBACtB,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;gBAClD,IAAI,SAAS,EAAE,CAAC;oBACd,OAAO;wBACL,OAAO,EAAE;4BACP;gCACE,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,iGAAiG,UAAU,aAAa,UAAU,CAAC,MAAM,oCAAoC,UAAU,oBAAoB;6BAClN;yBACF;qBACF,CAAC;gBACJ,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;YAED,eAAe;YACf,IACE,WAAW,CAAC,MAAM,KAAK,aAAa;gBACpC,WAAW,CAAC,MAAM,KAAK,mBAAmB;gBAC1C,WAAW,CAAC,MAAM,KAAK,cAAc,EACrC,CAAC;gBACD,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,uEAAuE,UAAU,aAAa,WAAW,CAAC,MAAM,gKAAgK;yBACvR;qBACF;oBACD,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;YAED,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC;YACtC,MAAM,YAAY,GAAG,KAAK;iBACvB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;iBACvC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEd,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,4BAA4B,IAAI,CAAC,IAAI,sBAAsB,UAAU,aAAa,IAAI,CAAC,SAAS,cAAc,IAAI,CAAC,OAAO,sBAAsB,KAAK,CAAC,MAAM,kBAAkB,YAAY,+BAA+B,UAAU,mBAAmB;qBAC7P;iBACF;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,oCAAoC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;qBACnG;iBACF;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}

package/dist/tools/create-test-flow.d.ts

@@ -0,0 +1,4 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { type ApiClient } from "../api-client.js";
+export declare function registerCreateTestFlowTool(server: McpServer, client: ApiClient): void;
+//# sourceMappingURL=create-test-flow.d.ts.map

package/dist/tools/create-test-flow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-test-flow.d.ts","sourceRoot":"","sources":["../../src/tools/create-test-flow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAEzE,OAAO,EAA4B,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAid5E,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,SAAS,GAChB,IAAI,CA2KN"}