@mablhq/mabl-cli 2.65.3 → 2.67.0

package/cli.js

@@ -66,6 +66,7 @@ yargs
     .commandDir('./commands/test-runs')
     .commandDir('./commands/users')
     .commandDir('./commands/workspaces')
+    .commandDir('./commands/mcp')
     .demandCommand(1, '')
     .recommendCommands()
     .strict()

package/commands/mcp/mcp.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = 'mcp <command>';
+exports.describe = false;
+exports.builder = (yargs) => yargs.commandDir('mcp_cmds').demandCommand();

package/commands/mcp/mcp_cmds/start.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../commandUtil/util");
+const index_js_1 = require("@modelcontextprotocol/sdk/server/index.js");
+const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
+const types_js_1 = require("@modelcontextprotocol/sdk/types.js");
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+const tools_1 = __importDefault(require("./tools"));
+const constants_1 = require("../../constants");
+exports.command = 'start [options]';
+exports.describe = 'Start the MCP server';
+exports.builder = (yargs) => {
+    yargs
+        .option(constants_1.CommandArgApiKey, {
+        alias: constants_1.CommandArgAliases.ApiKey,
+        describe: 'API key (found in the mabl web app)',
+        nargs: 1,
+        demand: 'API key argument required',
+        type: 'string',
+    })
+        .example('$0 mcp server', 'Start the MCP server');
+};
+exports.handler = (0, util_1.failWrapper)(startServer);
+async function startServer(parsed) {
+    (0, loggingProvider_1.disableLogging)();
+    const server = new index_js_1.Server({
+        name: 'mabl',
+        version: '1.0.0',
+    }, {
+        capabilities: {
+            tools: {},
+        },
+    });
+    server.setRequestHandler(types_js_1.ListToolsRequestSchema, () => ({
+        tools: tools_1.default.map((tool) => ({
+            name: tool.schema.name,
+            description: tool.schema.description,
+            inputSchema: tool.schema.inputSchema.safeParse({}).success
+                ? { type: 'object', properties: {} }
+                : {
+                    type: 'object',
+                    properties: Object.fromEntries(Object.entries(tool.schema.inputSchema.shape).map(([key, value]) => {
+                        const description = value._def.description;
+                        return [
+                            key,
+                            {
+                                type: 'string',
+                                description: description || '',
+                            },
+                        ];
+                    })),
+                },
+        })),
+    }));
+    server.setRequestHandler(types_js_1.CallToolRequestSchema, async (request) => {
+        const { name } = request.params;
+        const tool = tools_1.default.find((t) => t.schema.name === name);
+        if (!tool) {
+            throw new Error(`Unknown tool: ${name}`);
+        }
+        try {
+            const args = request.params.arguments || {};
+            const result = await tool.handle(args, parsed[constants_1.CommandArgApiKey]);
+            return {
+                content: result.content,
+            };
+        }
+        catch (error) {
+            throw error;
+        }
+    });
+    const transport = new stdio_js_1.StdioServerTransport();
+    await server.connect(transport);
+    console.error('Mabl MCP Server running on stdio');
+}

package/commands/mcp/mcp_cmds/tools/analyzeFailure.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mcpMablTool_1 = require("./mcpMablTool");
+const zod_1 = require("zod");
+const analyzeFailure = (0, mcpMablTool_1.defineTool)({
+    schema: {
+        name: 'analyze-failure',
+        title: 'Analyze a mabl test execution failure',
+        description: 'Analyze a mabl test execution failure',
+        inputSchema: zod_1.z.object({
+            runId: zod_1.z.string().describe('The runId of the failed test run to analyze'),
+        }),
+        type: 'readOnly',
+    },
+    handle: (params) => {
+        const runId = params.runId;
+        const failureSynopsis = 'Failed at Step 6: The text on the page changed, causing an assertion failure.';
+        const failureSummary = 'The test is failing because the text on the page has changed from "step 1: create a test!" to "step 1: create a journey!". The assertion in the test is expecting the original text, which is why the test is failing. It appears that the application under test has been updated so that it now displays "step 1: create a journey!" instead of "step 1: create a test!". To resolve this failure, you should update the assertion in the test to expect the new text, "step 1: create a journey!".';
+        const summary = `RunId: ${runId} Status: failed FailureSynopsis: ${failureSynopsis} FailureDetails: ${failureSummary}`;
+        return Promise.resolve({
+            content: [
+                {
+                    type: 'text',
+                    text: summary,
+                },
+            ],
+        });
+    },
+});
+exports.default = [analyzeFailure];

package/commands/mcp/mcp_cmds/tools/getEnvironments.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../../commandUtil/util");
+const mcpMablTool_1 = require("./mcpMablTool");
+const mablApiClientFactory_1 = require("../../../../api/mablApiClientFactory");
+const zod_1 = require("zod");
+const getEnvironments = (0, mcpMablTool_1.defineTool)({
+    schema: {
+        name: 'get-environments',
+        title: 'Get all mabl environments',
+        description: 'Get all mabl environments',
+        inputSchema: zod_1.z.object({}),
+        type: 'readOnly',
+    },
+    handle: async (_, apiKey) => {
+        const arg = {
+            'workspace-id': undefined,
+            output: 'json',
+            _: [],
+            $0: '',
+        };
+        const workspaceId = await (0, util_1.getWorkspaceId)(arg);
+        const limit = 500;
+        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClientFromOptionalApiKey(apiKey);
+        const environments = await apiClient.getEnvironments(workspaceId, limit);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: environments
+                        .map((env) => `Name: ${env.name} ID: ${env.id}`)
+                        .join('\n'),
+                },
+            ],
+        };
+    },
+});
+exports.default = [getEnvironments];

package/commands/mcp/mcp_cmds/tools/getRecentFailures.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mcpMablTool_1 = require("./mcpMablTool");
+const zod_1 = require("zod");
+const getRecentFailures = (0, mcpMablTool_1.defineTool)({
+    schema: {
+        name: 'get-recent-failures',
+        title: 'Get mabl tests with recent failures',
+        description: 'Get mabl tests with recent failures',
+        inputSchema: zod_1.z.object({}),
+        type: 'readOnly',
+    },
+    handle: () => Promise.resolve({
+        content: [
+            {
+                type: 'text',
+                text: 'Test: Sandbox training example ID: Pc0Kvc5gbqeDTWgf23LGLg-j Count: 8',
+            },
+        ],
+    }),
+});
+exports.default = [getRecentFailures];

package/commands/mcp/mcp_cmds/tools/getResults.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mcpMablTool_1 = require("./mcpMablTool");
+const zod_1 = require("zod");
+const mablApiClientFactory_1 = require("../../../../api/mablApiClientFactory");
+const getResults = (0, mcpMablTool_1.defineTool)({
+    schema: {
+        name: 'get-results',
+        title: 'Get recent mabl test run results',
+        description: 'Get recent mabl test run results',
+        inputSchema: zod_1.z.object({
+            testId: zod_1.z
+                .string()
+                .describe('The id of the mabl test to get recent results of'),
+        }),
+        type: 'readOnly',
+    },
+    handle: async (params, apiKey) => {
+        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClientFromOptionalApiKey(apiKey);
+        const testId = params.testId;
+        const testRunResults = (await apiClient.getRecentTestRunsForTest(testId))
+            .test_script_executions || [];
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: testRunResults
+                        .map((testRun) => {
+                        const id = testRun.id;
+                        const completedTimeMs = testRun.completed_time;
+                        const status = testRun.status;
+                        const envId = testRun.journey_parameters?.deployment?.environment_id;
+                        const errorMessage = testRun.failure_summary?.error;
+                        return `TestRunId: ${id} EnvironmentId: ${envId} Status: ${status} CompletedTimeMs: ${completedTimeMs} ErrorMessage: ${errorMessage}`;
+                    })
+                        .join('\n'),
+                },
+            ],
+        };
+    },
+});
+exports.default = [getResults];

package/commands/mcp/mcp_cmds/tools/getTests.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../../commandUtil/util");
+const mcpMablTool_1 = require("./mcpMablTool");
+const mablApiClientFactory_1 = require("../../../../api/mablApiClientFactory");
+const zod_1 = require("zod");
+const getTests = (0, mcpMablTool_1.defineTool)({
+    schema: {
+        name: 'get-tests',
+        title: 'Get all mabl tests',
+        description: 'Get all mabl tests',
+        inputSchema: zod_1.z.object({}),
+        type: 'readOnly',
+    },
+    handle: async (_, apiKey) => {
+        const arg = {
+            'workspace-id': undefined,
+            output: 'json',
+            _: [],
+            $0: '',
+        };
+        const workspaceId = await (0, util_1.getWorkspaceId)(arg);
+        const limit = 50;
+        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClientFromOptionalApiKey(apiKey);
+        const tests = await apiClient.getJourneys({
+            organization_id: workspaceId,
+            limit,
+        });
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: tests
+                        .map((test) => `Test: ${test.name} ID: ${test.invariant_id}`)
+                        .join('\n'),
+                },
+            ],
+        };
+    },
+});
+exports.default = [getTests];

package/commands/mcp/mcp_cmds/tools/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getEnvironments_1 = __importDefault(require("./getEnvironments"));
+const getTests_1 = __importDefault(require("./getTests"));
+const getRecentFailures_1 = __importDefault(require("./getRecentFailures"));
+const getResults_1 = __importDefault(require("./getResults"));
+const analyzeFailure_1 = __importDefault(require("./analyzeFailure"));
+const runTest_1 = __importDefault(require("./runTest"));
+exports.default = [
+    ...getEnvironments_1.default,
+    ...getTests_1.default,
+    ...getRecentFailures_1.default,
+    ...getResults_1.default,
+    ...analyzeFailure_1.default,
+    ...runTest_1.default,
+];

package/commands/mcp/mcp_cmds/tools/mcpMablTool.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineTool = defineTool;
+function defineTool(tool) {
+    return tool;
+}

package/commands/mcp/mcp_cmds/tools/runTest.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mcpMablTool_1 = require("./mcpMablTool");
+const zod_1 = require("zod");
+const run_1 = require("../../../tests/tests_cmds/run");
+const mablApiClientFactory_1 = require("../../../../api/mablApiClientFactory");
+const runTest = (0, mcpMablTool_1.defineTool)({
+    schema: {
+        name: 'run-test',
+        title: 'Run a mabl test',
+        description: 'Run a mabl test',
+        inputSchema: zod_1.z.object({
+            environmentId: zod_1.z
+                .string()
+                .describe('The id of the environment to run the test in'),
+            testId: zod_1.z.string().describe('The id of the test to run'),
+        }),
+        type: 'destructive',
+    },
+    handle: async (params, apiKey) => {
+        const mablApiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClientFromOptionalApiKey(apiKey);
+        const result = await (0, run_1.run)({
+            id: params.testId,
+            'environment-id': params.environmentId || '',
+            branch: 'master',
+            'branch-changes-only': false,
+            browser: 'chrome',
+            'browser-disable-isolation': false,
+            'browser-ignore-certificate-errors': false,
+            'enable-link': false,
+            headless: false,
+            height: 1024,
+            highlights: false,
+            'keep-browser-open': false,
+            'run-id': undefined,
+            width: 1024,
+            output: 'json',
+            url: 'http://sandbox-local.mabl.com:3000',
+            _: [],
+            $0: '',
+        }, false, mablApiClient);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `Test run ${result.success
+                        ? 'succeeded'
+                        : `failed ${result.testResults[0].errorMessage}`}`,
+                },
+            ],
+        };
+    },
+});
+exports.default = [runTest];

package/commands/tests/tests_cmds/run.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = run;
 const util_1 = require("../../commandUtil/util");
 const testsUtil_1 = require("../testsUtil");
 const constants_1 = require("../../constants");
@@ -218,7 +219,7 @@ Note: Setting the environment does not override the default URL. Please use the
 };
 const exitCodeOnError = 1;
 exports.handler = (0, util_1.failWrapper)(run, exitCodeOnError);
-async function run(parsed) {
+async function run(parsed, killProcessOnFailure = true, apiClient) {
     const commandStartTime = Date.now();
     let workspaceId;
     try {
@@ -236,7 +237,7 @@ async function run(parsed) {
     const browserType = (0, testsUtil_1.parseBrowserType)(parsed[constants_1.CommandArgBrowser]);
     let scenario;
     if (parsed[constants_1.CommandArgScenarioId]) {
-        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+        apiClient ??= await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
         scenario = await apiClient.getScenario(parsed[constants_1.CommandArgScenarioId]);
         if (!scenario) {
             throw new Error(`Scenario with ID ${parsed[constants_1.CommandArgScenarioId]} not found`);
@@ -295,13 +296,14 @@ async function run(parsed) {
             (0, testsUtil_1.cleanupTestResources)(testContext);
         });
     }
-    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    apiClient ??= await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
     await (0, runUtils_1.logTestResults)(results, parsed, commandStartTime, generateRunCommandTemplate(parsed, results), apiClient, browserType, parsed[constants_1.CommandArgVerbose]);
     if (!testRunnerConfig.keepBrowserOpen) {
-        if (!results.success) {
+        if (!results.success && killProcessOnFailure) {
             process.exit(1);
         }
     }
+    return results;
 }
 function generateRunCommandTemplate(parsed, testResults) {
     const testResult = testResults.testResults[0];