Skip to main content
Version: 3.2

MTA MCP Tools

This is a list of all available MCP Tools in MTA.

info

This file is AI generated.

AddTestCaseVariationItem​

  • Description: Enables data variations on a test case or includes a test step attribute, parameter, or assertion object as a variation item in the test case data variation matrix.
  • Prerequisites: TestCaseKey must exist when enabling variations, or ObjectKey must exist for the specified variation item type.
  • Returns: Confirmation status string on success or an error message string.

AddTestSuiteVariationItem​

  • Description: Enables data variations on a test suite or includes a test step attribute, parameter, or assertion object as a variation item in the test suite data variation matrix.
  • Prerequisites: TestSuiteKey must exist when enabling variations, or ObjectKey must exist for the specified variation item type.
  • Returns: Confirmation status string on success or an error message string.

CreateAssertAttributeValueCompare​

  • Description: Creates an AssertAttributeValueCompare entity on an Object Action test step for a specified attribute.
  • Prerequisites: TestStepKey and AttributeName must be provided, target test step must be an Object Action step (Create, Change, or Retrieve Object), attribute must exist on entity, assertion must not already exist, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "Assert attribute value compare has been created for teststep" on success, or an error message string.

CreateAssertException​

  • Description: Creates an exception assertion on a specified test step to verify runtime exception behavior.
  • Prerequisites: TestStepKey must exist, test step must not already have an exception assertion, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "Assert exception has been created for teststep" on success, or an error message string.

CreateAssertMicroflowReturnValue​

  • Description: Creates a Microflow Return Value assertion on a Microflow Call test step.
  • Prerequisites: TestStepKey, ComparisonOperator, and ActionFailedAssert must be provided, target test step must call a microflow that returns a primitive literal value, assertion must not already exist, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "Assert microflow return value compare has been created" on success, or an error message string.

CreateAssertObjectCount​

  • Description: Creates an object count assertion on a specified test step to verify the number of returned or manipulated objects.
  • Prerequisites: TestStepKey must exist, object count assertions must be allowed on the test step type, the test step must not already have an object count assertion, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "Assert object count has been created for teststep" on success, or an error message string.

CreateAssertValidationFeedbackMessageCompare​

  • Description: Creates an assertion on a test case to compare validation feedback messages on a target entity attribute or association.
  • Prerequisites: TestCaseKey, ModuleName, and EntityName must exist in the application revision, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "Assert validation feedback message compare has been created for test case" on success, or an error message string.

CreateAssertValidationFeedbackMessageCount​

  • Description: Creates an assertion on a test case to verify the total count of validation feedback messages.
  • Prerequisites: TestCaseKey must exist and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "Assert validation feedback message count has been created for test case" on success, or an error message string.

CreateExecutionUser​

  • Description: Creates a new execution user for a specified application and test configuration.
  • Prerequisites: ApplicationKey and TestConfigurationKey must exist, TestConfiguration must be unlocked, and Username must be non-empty.
  • Returns: String formatted as "ExecutionUserKey: <Key>" on success, or an error message string.

CreateMicroflowCallTestStep​

  • Description: Creates a microflow call test step within a specified test case to execute a backend microflow.
  • Prerequisites: TestCaseKey must exist, MicroflowQualifiedName must exist in the application revision model, and parent TestConfiguration must be unlocked.
  • Returns: String formatted as "Teststep key: <Key>" on success, or an error message string.

CreateObjectActionTestStep​

  • Description: Creates an object action test step (Create, Change, Retrieve, Delete, or Persist object) within a specified test case.
  • Prerequisites: TestCaseKey must exist, ObjectAction and TestStepName must be provided, EntityQualifiedName must exist in model (if required by action), TestStepOutputKey must exist (for Change/Delete actions), and parent TestConfiguration must be unlocked.
  • Returns: String formatted as "Teststep key: <Key>" on success, or an error message string.

CreateSelectObjectForAssociation​

  • Description: Creates a SelectObjectForAssociation entity on an Object Action test step to enable setting, adding, removing, or clearing association values.
  • Prerequisites: TestStepKey and AssociationQualifiedName must be provided, target test step must support associations (Create, Change, or Retrieve Object), association must exist in model, and parent TestConfiguration must be unlocked.
  • Returns: JSON string containing details and key of the created SelectObjectForAssociation entity on success, or an error message string.

CreateTestCase​

  • Description: Creates a new test case within a specified test suite.
  • Prerequisites: TestSuiteKey, ApplicationKey, and ExecutionUserKey must exist, parent TestConfiguration must be unlocked, and TestCaseName must be non-empty.
  • Returns: String formatted as "TestCaseKey: <Key>" on success, or an error message string.

CreateTestCaseVariation​

  • Description: Creates a new data variation column for a specified test case by duplicating the baseline variation structure with empty values.
  • Prerequisites: TestCaseKey must exist, have data variations enabled, and its parent TestConfiguration must be unlocked.
  • Returns: Confirmation string indicating the created variation key on success, or an error message string if creation fails.

CreateTestSuite​

  • Description: Creates a new test suite in a specified test configuration.
  • Prerequisites: TestConfigurationKey must exist, TestConfiguration must be unlocked, ApplicationRevisions must be loaded, and Name must be non-empty.
  • Returns: String formatted as "TestSuiteKey: <Key>" on success, or an error message string.

CreateTestSuiteVariation​

  • Description: Creates a new data variation column for a specified test suite by duplicating the baseline variation structure with empty values.
  • Prerequisites: TestSuiteKey must exist, have data variations enabled, and its parent TestConfiguration must be unlocked.
  • Returns: Confirmation string indicating the created variation key on success, or an error message string if creation fails.

EditAssertAttributeValueCompare​

  • Description: Edits expected values and comparison operators for an AssertAttributeValueCompare entity (Boolean, AutoNumber, DateTime, Decimal, Enumeration, HashString, Integer, Long, String, Range, or TrimString).
  • Prerequisites: AssertAttributeValueCompareKey must exist and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Assert attribute value compare has been edited" on success, or an error message string.

EditAssertException​

  • Description: Edits assertion condition (expecting exception vs. expecting success) and failure handling behavior on an existing exception assertion.
  • Prerequisites: AssertExceptionKey must exist and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Assert exception has been edited" on success, or an error message string.

EditAssertMicroflowReturnValueCompare​

  • Description: Edits comparison conditions, operators, and expected values on an existing Microflow Return Value assertion.
  • Prerequisites: AssertMicroflowReturnValueKey must exist, parent TestConfiguration must be unlocked, and operators and values must match the return type.
  • Returns: Confirmation string "The Assert microflow return value compare has been edited" on success, or an error message string.

EditAssertObjectCount​

  • Description: Edits the operator and expected count value on an existing Object Count assertion.
  • Prerequisites: AssertObjectCountKey must exist, ComparisonOperator must be valid, Count must be non-negative, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Assert object count has been edited" on success, or an error message string.

EditAssertValidationFeedbackMessageCompare​

  • Description: Edits the expected message text, comparison operator, or error action on an existing validation feedback message comparison assertion.
  • Prerequisites: AssertValidationFeedbackMessageCompareKey must exist, parent TestConfiguration must be unlocked, and ComparisonOperator must be valid.
  • Returns: Confirmation string "The Assert validation feedback message compare has been edited" on success, or an error message string.

EditAssertValidationFeedbackMessageCount​

  • Description: Edits the comparison operator and expected message count on an existing validation feedback message count assertion.
  • Prerequisites: AssertValidationFeedbackMessageCountKey must exist, ComparisonOperator must be valid, Count must be non-negative, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Assert validation feedback message count has been edited" on success, or an error message string.

EditAttributeValue​

  • Description: Configures attribute values across data types (String, Integer, Decimal, Boolean, DateTime, Enumeration, AutoNumber, etc.) for Create or Change Object test steps.
  • Prerequisites: TestStepKey and AttributeName must exist, target step must be Create or Change Object, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Attribute value has been edited" on success, or an error message string.

EditAttributeValueFilter​

  • Description: Edits attribute filter conditions on a Retrieve Object test step.
  • Prerequisites: TestStepKey and AttributeName must exist on the retrieved entity, target step must be Retrieve Object, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Attribute value filter has been edited" on success, or an error message string.

EditExecutionUser​

  • Description: Edits properties of an existing execution user (username, password, active status, or user roles).
  • Prerequisites: ExecutionUserKey must exist and parent TestConfiguration must be unlocked.
  • Returns: String formatted as "ExecutionUserKey: <Key>" on success, or an error message string.

EditMicroflowObjectParameter​

  • Description: Binds a prior test step's output object/list to an object-type input parameter of a microflow call test step.
  • Prerequisites: TestStepKey and ParameterName must exist on target step, parameter must be an object/list type, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Microflow Object parameter has been edited" on success, or an error message string.

EditMicroflowParameterValue​

  • Description: Configures literal values for primitive/enumeration parameters on a Microflow Call test step.
  • Prerequisites: TestStepKey and ParameterName must exist on target step, parameter must be a primitive or enumeration type, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Microflow parameter value has been edited" on success, or an error message string.

EditTestCase​

  • Description: Edits properties of an existing test case (name, active flag, continue on error, rollback transaction, execution user, or security role).
  • Prerequisites: TestCaseKey must exist and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Test case has been edited" on success, or an error message string.

EditTestCaseVariation​

  • Description: Edits cell values within a test case variation matrix by mapping item keys to their new string representation values.
  • Prerequisites: TestCaseVariationKey must exist, parent TestConfiguration must be unlocked, and provided VariationItemKeys must be part of the test case variation model.
  • Returns: Confirmation string "The variation value has been edited" on success, or an error message string.

EditTestStep​

  • Description: Edits general configuration properties of an existing test step (name, active status, or continue on error).
  • Prerequisites: TestStepKey must exist, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The teststep has been edited" on success, or an error message string.

EditTestStepAssociation​

  • Description: Configures association behavior (action type, target output step binding, or clear flag) on an Object Action test step.
  • Prerequisites: SelectObjectForAssociationKey must exist, provided association action must be valid, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Association has been edited" on success, or an error message string.

EditTestStepRetrieve​

  • Description: Edits the retrieve action settings (range, limit, offset, sorting attribute, sorting direction, or XPath constraint) for a Retrieve Object test step.
  • Prerequisites: TestStepKey must exist, target step must be a Retrieve Object step, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The Retrieve test step has been edited" on success, or an error message string.

EditTestSuite​

  • Description: Edits properties of an existing test suite (name, enabled status, or continue on error).
  • Prerequisites: TestSuiteKey must exist, parent TestConfiguration must be unlocked, and Name must be non-empty if provided.
  • Returns: Confirmation string "The Test suite has been edited" on success, or an error message string.

EditTestSuiteVariation​

  • Description: Edits cell values within a test suite variation matrix by mapping item keys to their new string representation values.
  • Prerequisites: TestSuiteVariationKey must exist, parent TestConfiguration must be unlocked, and provided VariationItemKeys must be part of the test suite variation model.
  • Returns: Confirmation string "The variation value has been edited" on success, or an error message string.

ExecuteTest​

  • Description: Triggers execution of a test run for a specific test suite or test case within a test configuration.
  • Prerequisites: TestConfigurationKey must exist, ExecuteAction must be valid, target TestSuiteKey or TestCaseKey must exist, TargetExecutionUrl must be non-empty, and either ExecutionUserKey or Username & Password must be provided.
  • Returns: JSON string with execution confirmation, run ID, and initial status, or an error message string.

GenerateMicroflowCallTestStepLocatePage​

  • Description: Generates a "Locate Mendix Page" microflow call test step within a test case to locate a specific Mendix UI page by its qualified name and CSS class during Playwright frontend testing.
  • Prerequisites: TestCaseKey must exist, PageQualifiedName and PageClassName must match a page in the application revision model, and parent TestConfiguration must be unlocked.
  • Returns: JSON string containing the generated test step details or an error message string.

GenerateMicroflowCallTestStepLocateWidget​

  • Description: Generates a "Locate Widget" microflow call test step within a test case to locate a specific UI widget during Playwright frontend testing.
  • Prerequisites: TestCaseKey must exist. When the widget form type is non-global, PageQualifiedName, PageClassName, and WidgetName must match a unique widget on the page in the application revision model.
  • Returns: JSON string containing the generated test step details or an error message string.

GetAppModelData​

  • Description: [READ-ONLY] Retrieves Mendix app model metadata (entities, microflows, pages, and widgets) synchronized with MTA for a given application and test configuration.
  • Prerequisites: TestConfigurationKey and ApplicationKey must exist and be active. Depending on RetrieveAction: PageQualifiedName (for RetrieveWidgetsByPage), EntityQualifiedName (for RetrieveEntityByApplicationAndTestConfiguration), MicroflowQualifiedName (for RetrieveMicroflowByApplicationAndTestConfiguration), or EnumerationQualifiedName (for RetrieveEnumerationByApplicationAndTestConfiguration) must be provided.
  • Returns: JSON array/object containing page definitions or widget structures, or an error message string if retrieval fails.

GetApplicationDetails​

  • Description: [READ-ONLY] Retrieves application details by application name or Mendix project ID (AppId).
  • Prerequisites: Either ApplicationName or AppId must be provided.
  • Returns: JSON string containing application details or an error message string.

GetExecutionUsers​

  • Description: [READ-ONLY] Retrieves execution users associated with a specific test configuration and application.
  • Prerequisites: TestConfigurationKey and ApplicationKey must exist, and TestConfiguration must be active.
  • Returns: JSON string containing the list of execution users or an error message string.

GetTestCaseDetails​

  • Description: Retrieves full details, specifications, and execution settings for a specified test case.
  • Prerequisites: TestCaseKey must exist.
  • Returns: JSON object string containing test case properties (name, objective, preconditions, expected result, security, execution settings), or an error message string if retrieval fails.

GetTestConfigurationDetails​

  • Description: Retrieves complete details, settings, and metadata of a specified test configuration.
  • Prerequisites: TestConfigurationKey must exist, and the TestConfiguration must be active and unlocked.
  • Returns: JSON object string containing test configuration specifications and properties, or an error message string if retrieval fails.

GetTestRunResults​

  • Description: Retrieves execution status, logs, and detailed results for a completed or running test run by its execution ID.
  • Prerequisites: TestRunExecutionId must exist and be valid.
  • Returns: JSON object string containing test run status, assertion outcomes, step execution logs, or an error message string if retrieval fails.

GetTestSuiteDetails​

  • Description: [READ-ONLY] Retrieves the full details of a specific test suite by its key.
  • Prerequisites: TestSuiteKey must exist and parent TestConfiguration must be unlocked.
  • Returns: JSON string containing test suite details or an error message string.

GetTeststepDetails​

  • Description: Retrieves detailed configuration and parameters of a specified test step, dynamically resolving Object Actions (Create, Change, Retrieve, Delete, Persist) and Microflow Call definitions.
  • Prerequisites: TestStepKey must exist, and the encompassing TestConfiguration must be unlocked.
  • Returns: JSON object string containing complete test step parameters and associations, or an error message string if retrieval fails.

MoveTestStepToOtherTestCase​

  • Description: Moves a specified test step from its current test case to a target test case within the same test suite.
  • Prerequisites: TestStepKey and TargetTestCaseKey must exist, target test case must be a valid candidate, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The teststep is moved to the target test case" on success, or an error message string.

SetSequenceOfTestCase​

  • Description: Reorders a test case within its test suite by placing it after the specified test case before (TestCaseBeforeKey).
  • Prerequisites: TestCaseKey must exist, parent TestConfiguration must be unlocked, and TestCaseBeforeKey (if provided) must belong to the same TestSuite. If TestCaseBeforeKey is empty or 0, the test case is placed first.
  • Returns: Confirmation string "The sequence is set for test case" on success, or an error message string.

SetSequenceOfTestStep​

  • Description: Sets the execution order of a test step within its test case by placing it directly after the existing step specified by TestStepBeforeKey (or first if 0).
  • Prerequisites: TestStepKey must exist, TestStepBeforeKey must be 0 or exist within the same test case, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "The sequence is set for teststep" on success, or an error message string.

SetSequenceOfTestSuite​

  • Description: Reorders a test suite within its test configuration by placing it after the specified test suite before (TestSuiteBeforeKey).
  • Prerequisites: TestSuiteKey must exist, parent TestConfiguration must be unlocked, and TestSuiteBeforeKey (if provided) must belong to the same TestConfiguration. If TestSuiteBeforeKey is empty or 0, the test suite is placed first.
  • Returns: Confirmation string "The sequence is set for test suit" on success, or an error message string.

SetTestStepOutputForSelectObjectForChange​

  • Description: Binds a prior test step output as the target object to be modified by a Change Object test step.
  • Prerequisites: SelectObjectForChangeKey and TestStepOutputKey must exist, the output step must output a compatible entity type, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "TeststepOutput has been set for SelectObjectForChange" on success, or an error message string.

SetTestStepOutputForSelectObjectForDelete​

  • Description: Binds a prior test step output as the target object to be removed by a Delete Object test step.
  • Prerequisites: SelectObjectForDeleteKey and TestStepOutputKey must exist, the output step must output a compatible entity type, and parent TestConfiguration must be unlocked.
  • Returns: Confirmation string "TeststepOutput has been set for SelectObjectForDelete" on success, or an error message string.
Last updated on