Skip to content

docs(ai): add getUserInputEvents MCP tool reference (KOB-54072) - #526

Open
tiffany-kobiton wants to merge 1 commit into
mainfrom
KOB-54072
Open

docs(ai): add getUserInputEvents MCP tool reference (KOB-54072)#526
tiffany-kobiton wants to merge 1 commit into
mainfrom
KOB-54072

Conversation

@tiffany-kobiton

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

Copy link
Copy Markdown
Contributor

Summary

New reference page for the getUserInputEvents MCP tool (release 4.27), plus a discoverability update to the Kobiton AI plugin tools reference.

  • Adds docs/modules/ai/pages/mcp/get-user-input-events.adoc (new tool detail page)
  • Adds nav entry under the MCP subsection
  • Adds a new row to the Sessions table on ai-plugin-mcp-ref.adoc with a xref to the new detail page

Scope

Documents what shipped in KOB-53093:

  • Signature, parameters, return
  • Touch and swipe payload shapes (with normalized 0..1 coordinates)
  • Scope: what's captured (canvas touch, canvas swipe) and what's not (keystrokes, right-clicks, pinch, drag-off-canvas, other views)
  • Retention: 200-event / 5-minute buffer with oldest-first eviction
  • Polling: `sinceTimestamp` cursor, non-destructive reads, ~1s latency
  • Authorization: session owner and org admins
  • Edge cases: future timestamp returns empty array

Ordering dependency (please merge in order)

This PR depends on merging before KOB-54076 (PR #525), or at least being live in the same build. PR #525 adds an xref from `device-only-view.adoc` → `get-user-input-events.adoc`. If #525 lands first, the Antora build will have an unresolved xref until this PR merges.

Recommended merge order:

  1. This PR (docs(ai): add getUserInputEvents MCP tool reference (KOB-54072) #526) → adds the target page
  2. Then docs(automation-testing): add device-only view page (KOB-54076) #525 → resolves the incoming xref

Or merge both together in the same batch.

Source

Test plan

  • Confirm nav ordering renders correctly (new bullet directly after `ai-plugin-mcp-ref.adoc` under MCP)
  • Confirm the Sessions table row + xref renders in `ai-plugin-mcp-ref.adoc`
  • Antora build succeeds with the xref to `automation-testing:device-only-view.adoc` (that page ships in KOB-54076 / PR docs(automation-testing): add device-only view page (KOB-54076) #525)
  • SME check: `timestamp` format — Unix epoch milliseconds? Unix seconds? ISO string? Docs currently show a numeric epoch-ms-shaped value; needs confirmation
  • SME check: does `sinceTimestamp` accept string or number? Should be stated once confirmed
  • Placeholder for future work: `// TODO:` comment in source (Return section) marks a spot for a full end-to-end call/response example, pending SME confirmation on above open questions

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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