Detect and Heal Change
The change-response workflow has two complementary phases:
Phase 1 - Heal API Definition: When a new spec version arrives, use
api_refactor_analyzeto identify operation mappings, additions, deletions, and parameter changes, then useapi_operation_applyto apply agent-confirmed mutations to the API definition and update the definition URL.Phase 2 - Heal Test Cases: Once the definition is synced, use
analyze_api_impactto identify which existing tests are broken by the changes, then userest_test_step_updateto fix impacted steps.
Run both phases together for a complete healing cycle - API definition synced, tests fixed, and project saved. Four-staged canned prompts wrap the underlying tools into a guided, checkpointed flow - see Staged canned prompts below.
Heal API Definition
API refactor analysis
api_refactor_analyzeREADAnalyzes API definition changes between the current spec stored in ReadyAPI and a new spec version. Wraps ReadyAPI refactoring logic to identify operation mappings with confidence scores, parameter additions, removals, and modifications, unmatched old operations with recommendations, and net-new operations.
Key parameters:
project*,apiName*,newSpec*,newSpecSourceType* (URL|FILE|CONTENT)
Try asking your AI client: "Analyze spec changes, propose operation mappings and changes."
API operation application
api_operation_applyWRITEApplies agent-confirmed changes to an API definition. Mutates operations (create, update, or delete) based on agent decisions and updates the project's definition URL to point to the new spec. Supports rollback through an optional backup copy. Returns a full summary of applied and failed changes, warnings, and definition URL update status.
Key parameters:
project*,apiName*,newSpecSourceType*,newSpec*,agentConfirmations*; optional:createDefaultRequests(default:true),createBackupCopy(default:true)
Try asking your AI client: "Apply the confirmed changes to the Order Service API and update the definition URL."
Heal Test Cases
Analyze API impact
analyze_api_impactREADDiffs a new spec against the existing one stored in ReadyAPI using openapi-diff-core. Matches changed endpoints to test suites and returns the full spec diff, a list of impacted test steps, and per-step healing advice.
Key parameters:
projectName*,apiName*,newSpec*,newSpecSourceType* - see SupportednewSpecSourceTypevalues.
Try asking your AI client: "Compare this new spec to what's in ReadyAPI and tell me which tests it breaks."
Supported newSpecSourceType values
newSpecSourceType accepts the following values for analyze_api_impact:
Value | Description |
|---|---|
| Remote URL pointing to a Swagger or OpenAPI definition. |
| Absolute path to a local OpenAPI/Swagger file (JSON or YAML). |
| Inline JSON or YAML spec content provided directly in the prompt. |
REST Test Step update
rest_test_step_updateWRITEApplies LLM-recommended parameter, request body, response, and assertion changes to a single named test step. Call once per impacted step. Returns applied and skipped changes with reasons, and whether the project was saved.
Key parameters:
projecttestSuite*,testCase*,testStep*; optional:parameterChanges[],requestBodyChanges[],responseChanges[],assertionChanges[]
Try asking your AI client: "Apply the recommended fixes to the impacted tests."
Input Schema
Defines the changes to apply to a single test step. Pass the values returned by analyze_api_impact directly; do not construct them manually.
Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Project name |
| string | Yes | Exact suite name from |
| string | Yes | Exact case name |
| string | Yes | Exact step name |
|
| No | Type of parameter change |
| string | No | Parameter name |
|
| No | Parameter location |
| string | No | Previous parameter type |
| string | No | Updated parameter type |
| boolean | No | Updated required flag |
|
| No |
|
| string | No | Slash-separated field path, for example, |
| string | No | Updated field type |
| - | No | Acknowledged and listed as skipped - response bodies are re-validated by the step's schema-compliance assertion after the spec update |
| string | No | Assertion type, for example, |
|
| No | Action to apply. |
| string | No | Required for |
| string | No | Required for JSONPath actions |
| string | No | Required for |
Output schema
Returned after processing the Input Schema above. Use applied[] and skipped[] to verify what changed. For any entry in skipped[] with healingAction: MANUAL_REVIEW, intervention in ReadyAPI is required before re-running.
Field | Type | Description |
|---|---|---|
| string | Project name |
| string | Suite name |
| string | Case name |
| string | Step name |
| array | Changes applied, each with |
| array | Changes skipped, each with |
| boolean | Whether the project was saved after applying the changes |