@mablhq/mabl-cli 2.70.4 → 2.70.10

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

@@ -5,16 +5,20 @@ const zod_1 = require("zod");
 const mablApiClientFactory_1 = require("../../../../api/mablApiClientFactory");
 const trainingSessions_1 = require("../../../../core/trainer/trainingSessions");
 const messaging_1 = require("../../../../core/messaging/messaging");
+const mablApi_1 = require("../../../../mablApi");
+const common_1 = require("./common");
 const runTest = (0, mcpMablTool_1.defineTool)({
     schema: {
         name: 'create-test',
         title: 'Create a mabl test',
-        description: 'Create a mabl test',
+        description: 'Create a mabl browser or API test',
         inputSchema: zod_1.z.object({
             environmentId: zod_1.z
                 .string()
                 .describe('The id of the environment to run the test in'),
-            url: zod_1.z.string().describe('The url of the application to test'),
+            url: zod_1.z
+                .string()
+                .describe('The url of the application to test. On API tests this will be the endpoint to test.'),
             name: zod_1.z.string().describe('The name of the test'),
             intent: zod_1.z.string().describe(`The intent of the test.
           Be as detailed as possible.
@@ -24,17 +28,29 @@ const runTest = (0, mcpMablTool_1.defineTool)({
             issueOrTicket: zod_1.z
                 .string()
                 .describe('The issue or ticket description that is being worked on. This will be used to generate the intent.'),
-            steps: zod_1.z
-                .string()
-                .describe('List of steps to accomplish the intent. Put each step in a new line.'),
+            steps: zod_1.z.string().describe(`List of steps to accomplish the intent. Put each step in a new line.
+          If you are testing an API, include data to be sent in the request and the expected response.
+          `),
             intentUrl: zod_1.z
                 .string()
                 .describe('Optional URL to be included in the intent')
                 .optional(),
+            isApiTest: zod_1.z
+                .boolean()
+                .describe('Whether the test is an API test. If true, the test will be created as an API test. False if the intent is unknown.'),
+            apiSpec: zod_1.z
+                .string()
+                .describe(`Optional API spec to be included in the intent. 
+          If provided, the test will be created as an API test.
+          This is required when creating an API test.`)
+                .optional(),
         }),
         type: 'destructive',
     },
     handle: async (params, apiKey) => {
+        if (params.isApiTest && !params.apiSpec) {
+            return (0, common_1.stringToToolResult)('apiSpec is required when creating an API test.', true);
+        }
         const mablApiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClientFromOptionalApiKey(apiKey);
         const workspaceId = (await mablApiClient.getApiKeyDetails()).workspace_id;
         messaging_1.mablEventEmitter.resetOutputEventChannel();
@@ -48,6 +64,9 @@ const runTest = (0, mcpMablTool_1.defineTool)({
         if (params.issueOrTicket) {
             fullIntent += `\n\nIssue or ticket: ${params.issueOrTicket}`;
         }
+        if (params.apiSpec) {
+            fullIntent += `\n\nAPI spec: ${params.apiSpec}`;
+        }
         await (0, trainingSessions_1.trainNewTest)({
             environmentId: params.environmentId,
             url: params.url,
@@ -56,6 +75,8 @@ const runTest = (0, mcpMablTool_1.defineTool)({
             autoLogin: false,
             workspaceId,
             intent: fullIntent,
+            testType: params.isApiTest ? mablApi_1.TestTypeEnum.Api : mablApi_1.TestTypeEnum.Browser,
+            apiDescription: params.apiSpec,
         }, mablApiClient, false);
         return {
             content: [

package/core/trainer/trainingSessions.js

@@ -27,7 +27,7 @@ async function trainNewTest(trainingSessionOptions, mablApiClient, waitProcessTo
         (await (0, util_1.getApiClientFromOptions)(trainingSessionOptions, true));
     const branchName = trainingSessionOptions.branchName ?? constants_1.DefaultBranchName;
     const { authToken, autoBranch, dataTableIds, intent: testIntent, ...passThroughFields } = trainingSessionOptions;
-    const { applicationId, autoLogin, credentialsId, environmentId, height, planId, testDescription, testName, url, width, workspaceId, } = passThroughFields;
+    const { apiDescription, applicationId, autoLogin, credentialsId, environmentId, height, planId, testDescription, testName, url, width, testType, workspaceId, } = passThroughFields;
     if (branchName !== 'master') {
         await (0, branches_1.checkBranchNameAndAutoBranchMaybe)(workspaceId, apiClient, branchName, autoBranch);
     }
@@ -62,6 +62,8 @@ async function trainNewTest(trainingSessionOptions, mablApiClient, waitProcessTo
     (0, testsUtil_1.logTestInfoIfPresent)(`Credentials ID: `, credentialsId);
     (0, testsUtil_1.logTestInfoIfPresent)(`Datatable ID(s): `, dataTableIds?.join(', '));
     (0, testsUtil_1.logTestInfoIfPresent)(`Test description: `, testDescription);
+    (0, testsUtil_1.logTestInfoIfPresent)(`Test type: `, testType);
+    (0, testsUtil_1.logTestInfoIfPresent)(`API description: `, apiDescription);
     const scriptConfig = {
         ...passThroughFields,
         accountId: account.id,