Skip to content

docs(ai): backfill plugin reference table with TCM tools and getOrgSettings - #528

Closed
tiffany-kobiton wants to merge 1 commit into
KOB-54073from
docs-mcp-ref-backfill
Closed

docs(ai): backfill plugin reference table with TCM tools and getOrgSettings#528
tiffany-kobiton wants to merge 1 commit into
KOB-54073from
docs-mcp-ref-backfill

Conversation

@tiffany-kobiton

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

Copy link
Copy Markdown
Contributor

Summary

Backfills `ai-plugin-mcp-ref.adoc` with 15 MCP tools shipped between 4.26.0S and 4.27 but never added to the reference table. Bundles the follow-on uncomment edits to `monitor-test-run.adoc` from PR #527.

Contents

Plugin reference table (`ai-plugin-mcp-ref.adoc`):

  • Header count updated: `13 MCP tools across 4 domains` → `29 MCP tools across 7 domains`
  • Sessions table: +1 row for `getUserInputEvents` (byte-identical to PR docs(ai): add getUserInputEvents MCP tool reference (KOB-54072) #526's addition)
  • Account table: +1 row for `getOrgSettings`
  • Test cases table (NEW section): 5 rows — `saveTestCase`, `listTestCases`, `getTestCase`, `updateTestCase`, `deleteTestCase`
  • Test runs table (NEW section): 4 rows — `createTestRun`, `listTestRuns`, `getTestRun`, `terminateTestRun`
  • Test suites table (NEW section): 5 rows — `listTestSuites`, `getTestSuite`, `createTestSuite`, `updateTestSuite`, `deleteTestSuite`

Monitor test run page (`monitor-test-run.adoc`):

  • Uncommented the two See also xrefs (`createTestRun`, `getOrgSettings`)
  • Wrapped `createTestRun` in the Before you begin section as an inline xref to the plugin reference

Branching / stacking

This PR is stacked on KOB-54073 (PR #527), which itself is off main. Target base is `KOB-54073` — when #527 merges to main, GitHub will auto-retarget this PR to main.

Recommended merge order:

  1. docs(ai): add getUserInputEvents MCP tool reference (KOB-54072) #526 (KOB-54072 — getUserInputEvents page)
  2. docs(ai): add monitorTestRun workflow page (KOB-54073) #527 (KOB-54073 — monitorTestRun workflow page)
  3. This PR (backfill)

If #526 merges after this backfill, the `getUserInputEvents` row addition in the Sessions table is byte-identical — git should handle it as a no-op, no conflict expected.

Source

  • Jira: no dedicated ticket (content-debt cleanup identified while drafting KOB-54073)
  • Tools sourced from:
    • KOB-52949 — TCM MCP tools (14 tools, released 4.26.0S)
    • KOB-53298 — `getOrgSettings` (released 4.27)
    • KOB-54072 — `getUserInputEvents` (released 4.27)

Test plan

  • Confirm all 7 domain tables render correctly on the reference page
  • Confirm the two new See also xrefs on the monitor-test-run page resolve
  • Confirm the inline xref on `createTestRun` in the Before you begin section resolves
  • SME review of the 15 new one-line descriptions for accuracy

🤖 Generated with Claude Code

…ttings

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@tiffany-kobiton tiffany-kobiton self-assigned this Aug 14, 2026
@tiffany-kobiton tiffany-kobiton added release: major new doc An entirely new page must be made ready for review Doc is ready for review labels Aug 14, 2026
@tiffany-kobiton

Copy link
Copy Markdown
Contributor Author

This PR has been superseded by one Tung made. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new doc An entirely new page must be made ready for review Doc is ready for review release: major

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant