Skip to content

docs(ai): add monitorTestRun workflow page (KOB-54073)#527

Open
tiffany-kobiton wants to merge 2 commits into
mainfrom
KOB-54073
Open

docs(ai): add monitorTestRun workflow page (KOB-54073)#527
tiffany-kobiton wants to merge 2 commits into
mainfrom
KOB-54073

Conversation

@tiffany-kobiton

@tiffany-kobiton tiffany-kobiton commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary

New workflow page for the `monitorTestRun` MCP skill (release 4.27, marked beta).

  • Adds `docs/modules/ai/pages/workflows/monitor-test-run.adoc`
  • Introduces a new `Workflows` subsection under AI in `ai/nav.adoc`
  • New page directory: `docs/modules/ai/pages/workflows/` (reserved for future task-oriented AI workflow docs, distinct from the low-level MCP tools reference in `ai/pages/mcp/`)

Scope

Documents `monitorTestRun` per KOB-53297:

  • What the skill does (watches Claude-launched runs, surfaces blockers)
  • Signature and polling behavior
  • Two blocker branches: Live Remediation enabled vs not enabled
  • Multi-execution and suite run handling
  • Errors and edge cases
  • Beta status marked in a NOTE at the top

Explicitly out of scope (documented in a follow-on):

  • `createTestRun` and other 14 tools from KOB-52949 (referenced inline in prose but not yet in the plugin reference table)
  • `getOrgSettings` from KOB-53298 (referenced inline in prose but not in the plugin reference table)

Both future xrefs are pre-drafted in the See also section as `//` AsciiDoc comments, ready to uncomment once the plugin reference table is backfilled.

Does not re-document Live Remediation itself; xrefs out to the existing `test-management/pages/remediations.adoc`.

Style / terminology

  • Uses `KobiAI` per existing customer docs (`remediations.adoc`) and UI label
  • Capitalizes `Live Remediation` as a product feature name
  • Beta callout scoped to the MCP skill only (Live Remediation itself remains framed as GA per `remediations.adoc`)

Potential nav merge conflict with PR #526 (KOB-54072)

Both branches modify `docs/modules/ai/nav.adoc` in adjacent locations:

Git may auto-merge cleanly. If not, the resolution is trivial: keep both additions in their intended positions.

Source

Test plan

  • Confirm the new `Workflows` subsection renders correctly in the AI section of the nav
  • Attach screenshots to `docs/modules/ai/images/`:
    • `monitor-test-run-blocker.png` — Claude chat showing a blocker notification with the blocked step, assigned device, and Live Remediation link
    • `monitor-test-run-summary.png` — Claude chat showing the final multi-execution summary
  • SME check: exact wording of the two skill-posted explainer strings (flag ON vs flag OFF)
  • SME check: confirm Live Remediation is still framed as beta in 4.27 (easy to strip the NOTE if promoted to GA)
  • Follow-on (not this PR): backfill `ai-plugin-mcp-ref.adoc` with the 14 KOB-52949 TCM tools + `getOrgSettings` + `getUserInputEvents`; then uncomment the two See also lines in this page

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Updated the documentation for the monitorTestRun MCP skill to clarify its functionality and improve readability.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant