Build and Maintain Structure

Full Create/Update/Delete coverage across the project hierarchy, plus scaffolding a new REST request test step. These tools write directly to the project - review changes before committing to a version control system.

Version 1.2.0: consolidated tools

Version 1.2.0 consolidates all delete tools in this group into one parameterized tool. For the full mapping of old tool names to new calls, see the following table.

delete WRITE

Removes an entity permanently. Names are case-insensitive. Errors: NOT_FOUND, CLOSED, or No <entity> named <name>.

Note

Deleting a project removes it only from the workspace. Project files are not deleted from the disk.

Deleting a resource cascades to all child methods and requests.

Data-driven test steps cannot be deleted through MCP. Use the ReadyAPI UI instead.

Key parameters:

  • kind* - one of project, suite, case, step, authProfile, resource, method, request.

  • ref* - path to the target entity. Include enough identifiers to resolve it uniquely within its parent chain.

  • deleteAllRequests - optional, kind: "request" only. Set to true to delete all requests under the target method.

Try asking your AI client: "Remove the Legacy-Payments project from my workspace." "Delete the deprecated Legacy Login suite."

* Required parameter.

ref examples

delete("project",    { projectName })
delete("suite",      { projectName, testSuiteName })
delete("case",       { projectName, testSuiteName, testCaseName })
delete("step",       { projectName, testSuiteName, testCaseName, testStepName })
delete("authProfile",{ projectName, authProfileName })

delete("resource",   { projectName, apiName, resourcePath })
delete("method",     { projectName, apiName, resourcePath, httpMethod })
delete("request",    { projectName, apiName, resourcePath, httpMethod, requestName })
delete("request",    { projectName, apiName, resourcePath, httpMethod }, deleteAllRequests: true)
    
Table 119. Superseded build and maintain structure tools

Version 1.1.0 tool

Version 1.2.0 equivalent

project_delete

delete("project", { projectName })

suite_delete

delete("suite", { projectName, testSuiteName })

case_delete

delete("case", { projectName, testSuiteName, testCaseName })

step_delete

delete("step", { projectName, testSuiteName, testCaseName, testStepName })

api_method_delete

delete("method", { projectName, apiName, resourcePath, httpMethod })

api_request_delete

delete("request", { projectName, apiName, resourcePath, httpMethod, requestName })

api_resource_delete

delete("resource", { projectName, apiName, resourcePath })

auth_profile_delete

delete("authProfile", { projectName, authProfileName })



Version 1.1.0: individual tools

project_create WRITE

Creates a new ReadyAPI project and registers it in the workspace. Creates the destination folder if it does not already exist.

Key parameters:

  • projectName*, folderPath*

Try asking your AI client: "Create a new ReadyAPI project called Payments-V2 in /projects/payments."

project_update WRITE

Updates elements of an existing project. Supports updating both built-in and custom project properties. Returns an error if a built-in property does not exist.

Note

For composite projects, encrypted properties, or script language changes, modifications should be made through the ReadyAPI UI.

Key parameters:

  • projectName* — optional: projectProperties, customProperties

Try asking your AI client: "Update the custom properties of the Billing project."

suite_create WRITE

Creates a new, empty test suite. The suite name must be unique within the project.

Key parameters:

  • projectName*, testSuiteName*

Try asking your AI client: "Create a new test suite called Payments Smoke Tests in the Billing project."

suite_update WRITE

Renames an existing test suite.

Key parameters:

  • projectName*, testSuiteName*, newTestSuiteName*

Try asking your AI client: "Rename the Smoke Tests suite to Payments Smoke v2."

case_create WRITE

Creates a new test case. Creates the parent suite automatically if it does not already exist.

Key parameters:

  • projectName*, testSuiteName*, testCaseName*

Try asking your AI client: "Add a new test case called Refund Flow to the Payments Smoke Tests suite."

case_update WRITE

Renames a test case and optionally enables or disables it.

Key parameters:

  • projectName*, testSuiteName*, testCaseName*, newTestCaseName*, enabled

Try asking your AI client: "Rename Refund Flow to Partial Refund Flow and disable it for now."

step_update WRITE

Renames a test step and optionally enables or disables it.

Key parameters:

  • projectName*, testSuiteName*, testCaseName*, testStepName*, newTestStepName*, enabled

Try asking your AI client: "Rename the Submit Order step to Submit Order v2."

step_create_rest WRITE

Creates a REST request test step against an existing API resource. Supports optional parameters, headers, body, file attachments, auth, environment, and initial assertions. The test suite and test case are created automatically if they do not already exist.

Key parameters:

  • targetSuiteName*, targetRequestName*, testSuiteName*, targetRequestMethod*, targetResourcePath*, suiteName*, caseName*, stepName* - optional: parameters, headers, body, attachmentUrls, authorization, environmentName, assertions

Try asking your AI client: "Add a REST request step that calls GET /invoices/{id} to the Refund Flow test case."

step_create_http WRITE

Creates an HTTP Request test step inside a named test case. Unlike REST, it is not tied to an imported API definition and is used for standalone HTTP/HTTPS calls to any URL — such as auth token endpoints, webhooks, or third-party services. Supports method, endpoint, parameters, headers, request body, auth, timeout, follow redirects, and assertions.

Key parameters:

  • testSuiteName*, testCaseName*, stepName*, endpoint* - optional: method, parameters, headers, authorization, timeout, followRedirects, multiValueDelimiter, sendParametersAs, environmentName, assertions

Try asking your AI client: "Add an HTTP request step that calls the auth token endpoint in the Refund Flow test case."

step_update_http WRITE

Updates an existing HTTP Request test step. Unlike REST request steps, HTTP Request steps are not tied to an imported API definition and are used for standalone HTTP/HTTPS calls to any URL. Supports partial updates — supply only the parameters you want to change.

Key parameters:

  • projectName*, suiteName*, caseName*, stepName* — optional: method, endpoint, parameters, headers, body, authorization, encoding, timeout, followRedirects, follow302WithGet, multiValueDelimiter, sendEmptyParameters, assertions

Try asking your AI client: "Update the auth token step in the Refund Flow test case to use the new endpoint."

step_create_kafka_publish WRITE

Creates a Kafka Publish test step in a named test case. The test suite and test case are created automatically if they do not already exist. Requires an existing Kafka API in the project.

Key parameters:

  • projectName*, suiteName*, caseName*, targetApiName*, targetOperationName*, channel*, message* — optional: stepName, key, parameters, connectionProperties, authorization, environmentName

Try asking your AI client: "Add a Kafka Publish step that sends a message to the orders topic in the Payments test case."

step_create_kafka_subscribe WRITE

Creates a Kafka Subscribe test step in a named test case. The test suite and test case are created automatically if they do not already exist. Requires an existing Kafka API in the project. At least one of maxMessages, maxRunTimeMs, or maxIdleTimeMs must be greater than 0 to prevent an open-ended subscribe that never terminates.

Key parameters:

  • projectName*, suiteName*, caseName*, targetApiName*, targetOperationName*, channel* — optional: stepName, stopWhen (ANY | ALL, default ANY), maxMessages, maxRunTimeMs, maxIdleTimeMs, ignoreMessagesBeforeConnect, connectionProperties, authorization, assertions

Try asking your AI client: "Add a Kafka Subscribe step that listens on the orders topic and stops after 10 messages."

step_update_kafka_publish WRITE

Updates an existing Kafka Publish test step. Supports partial updates — supply only the parameters you want to change.

Key parameters:

  • projectName*, suiteName*, caseName*, targetApiName*, targetOperationName*, channel*, message* — optional: stepName, key, parameters, connectionProperties, authorization

Try asking your AI client: "Update the Kafka Publish step in the Payments test case to use the new orders-v2 topic."

step_create_property_transfer WRITE

Creates a Property Transfer test step in a named test case. A Property Transfer step moves a value from a source property (a prior response, another test step, or a project, suite, or case property) into a target property. A single step can contain multiple transfers, each run in order. Supports XPath, XQuery, and JSONPath for node selection.

Key parameters:

  • projectName*, suiteName*, caseName*, stepName* — optional: transfers (list of source/target transfer configurations)

Try asking your AI client: "Add a property transfer step that passes the order ID from the Submit Order response to the Verify Order request."

api_request_create WRITE

Creates a new request under a given API resource. Supports method, request name, endpoint, and a parameter table with type and default values.

Key parameters:

  • projectName*, apiName*, resourcePath*, httpMethod*, requestName* - optional: requestParams

Try asking your AI client: "Create a POST request called CreateOrder under /orders in the Payments API."

api_request_update WRITE

Modifies a REST request's basic identity and configuration — endpoint, HTTP method, and request name. Supports partial updates; returns the updated API info on success or the reason for failure.

Key parameters:

  • projectName*, apiName*, resourcePath*, httpMethod*, xmlbeansRequestId* - optional: requestName, endpoint, soapMethod, authProfileName

Try asking your AI client: "Update the endpoint and method of the CreateInvoice request in the Payments API."

api_method_create WRITE

Creates a new HTTP method on an existing API resource.

Key parameters:

  • projectName*, apiName*, resourcePath*, httpMethod*, methodName*

Try asking your AI client: "Add a DELETE method to the /orders resource in the Payments API."

api_method_update WRITE

Modifies an existing API method — updates the HTTP method on a given resource path. Supports partial updates; returns the updated API info on success or the reason for failure.

Key parameters:

  • projectName*, apiName*, resourcePath*, httpMethod*

Try asking your AI client: "Change the HTTP method of /pets GET to POST in the Petstore API."

api_resource_create WRITE

Creates a new resource with a given name and path under an existing API.

Key parameters:

  • projectName*, apiName*, resourcePath*, resourceName*

Try asking your AI client: "Add a /refunds resource to the Payments API."

api_resource_update WRITE

Renames an existing API resource and updates its path. Supports partial updates; returns the updated API info on success or the reason for failure.

Key parameters:

  • projectName*, apiName*, resourcePath* - optional: newResourcePath, newResourceName

Try asking your AI client: "Rename the /pets resource to /animals in the Petstore API."

auth_profile_create WRITE

Creates an Auth Profile under a given project. Supported types: Basic, Digest, NTLM, and AWS Signature. Secret values are write-only and never returned in responses.

Key parameters:

  • projectName*, authProfileName*, authProfileType* - optional: properties, credentials

Try asking your AI client: "Create a Basic auth profile called Payments-Auth in the Billing project."

auth_profile_update WRITE

Modifies an existing Auth Profile's custom properties or type-specific credential fields. Returns updated non-secret profile object on success.

Key parameters:

  • projectName*, authProfileName*, authProfileType* - optional: properties, credentials

Try asking your AI client: "Update the API key on the AWS Signature profile in the Payments project."

environment_create WRITE

Creates a new environment in a project. Sensitive data (secrets, passwords, tokens) is optional and never returned in plain text — secrets are masked or provided as encrypted placeholders in responses.

Key parameters:

  • projectName*, environmentName* — optional: customProperties, restSettings (endpoint, auth name, proxy details), jdbcParameters

Try asking your AI client: "Create a Staging environment in the Billing project."

See Also

Publication date: