Skip to main content
Tools for listing recordings, retrieving session data, and accessing recording resources (video, console logs, network logs, user actions). All recording tools are read-only.

​
Listing

​
userplane_list_recordings

List screen recordings in a workspace. Recordings are screen captures from end users. Filter by project, link, or creator. Returns paginated results newest first.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
pagenumberNoPage number (default: 1)
per_pagenumberNoResults per page (default: 10, max: 50)
project_idstringNoFilter by project ID
link_idstringNoFilter by link ID
created_bystringNoFilter by creator workspace member ID
Returns: Paginated list of recordings. Each entry includes recordingId, durationMs, createdAt, expiresAt, creatorName, linkTitle, and a playerUrl that opens the recording in the dashboard player.

​
Recording details

​
userplane_get_rec_info

Retrieve complete details for a screen recording including duration, metadata, and upload status. Use the recording resource tools to access video, thumbnail, and log files.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
Returns: A flat object with recordingId, durationMs, startedAt, createdAt, expiresAt, status, linkId, linkTitle, projectId, projectTitle, domainUrl, creatorName, and a playerUrl for the dashboard player.

​
userplane_get_rec_video

Retrieve a time-limited presigned URL to download or stream the screen recording video file.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
Returns: recordingId, a presigned url (expires after a short time window), and durationMs.

​
userplane_get_rec_thumb

Retrieve a presigned URL for the recording’s thumbnail preview image.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
Returns: recordingId and a presigned url for the thumbnail image (expires after a short time window).

​
Session data

​
userplane_get_rec_console

Retrieve browser console log entries captured during the recording. Returns an array of log entries with level, message, timestamp, and optional stack traces. Useful for debugging errors and warnings.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
Returns: recordingId and an entries array. Each entry includes:
  • log_type — log level (error, warning, info, log, debug)
  • args — log message content
  • timestamp — time relative to recording start
  • trace — stack trace (if available)
  • url — page URL where the log was emitted

​
userplane_get_rec_network

Retrieve network request/response log entries captured during the recording. Returns an array of entries with URL, method, status, duration, headers, and bodies. Useful for diagnosing API issues.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
Returns: recordingId and an entries array. Each entry includes:
  • url — request URL
  • method — HTTP method
  • status — response status code
  • duration — request duration in milliseconds
  • headers — request and response headers
  • body — request and response bodies (when captured)
  • timestamp — time relative to recording start

​
userplane_get_rec_actions

Retrieve user interaction events captured during the recording. Returns an array of actions including clicks, navigation, tab switches, and page lifecycle events.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
Returns: recordingId and an entries array. Each entry includes:
  • type — action type (click, navigation, tab switch, page lifecycle)
  • timestamp — time relative to recording start
  • data — action-specific details (element selector, URL, event type)

​
Interactive viewers

These tools render rich, interactive viewers in AI clients that support MCP Apps. In other clients, they return the same data as structured text.

​
userplane_show_recording

Display the full interactive recording viewer with video playback, session metadata, and tabbed access to console logs, network requests, and user actions.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
See Recording Viewer for details.

​
userplane_show_rec_console

Display an interactive console log viewer with level filtering, full-text search, and expandable entries.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
See Resource Viewers for details.

​
userplane_show_rec_network

Display an interactive network request viewer with type filtering, status codes, durations, and expandable headers and bodies.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
See Resource Viewers for details.

​
userplane_show_rec_actions

Display an interactive user action viewer with type filtering, search, and expandable event details.
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID
recordingIdstringYesRecording ID
See Resource Viewers for details.

​
Example prompts

List the 5 most recent recordings in workspace {workspaceId}. For each one, tell me who submitted it, which project it belongs to, and when it was created.

A customer just submitted a recording in the Billing project. Pull up the latest recording and tell me what went wrong.

Here's a recording from a customer who can't complete checkout: https://dash.userplane.io/{workspaceId}/recordings/{recordingId} — what's causing the issue?

Give me a full root cause analysis of this recording. Check the console for JavaScript errors, the network requests for failed API calls, and the user actions for anything unusual. Summarize what happened and what likely caused the issue. https://dash.userplane.io/{workspaceId}/recordings/{recordingId}

Show me the console logs for this recording. Are there any JavaScript errors or unhandled exceptions? https://dash.userplane.io/{workspaceId}/recordings/{recordingId}

Check the network requests in this recording. Are there any 500 errors, 404s, or requests that took longer than 3 seconds? https://dash.userplane.io/{workspaceId}/recordings/{recordingId}

Walk me through what the user did in this recording. What pages did they visit, what did they click, and where did things break? https://dash.userplane.io/{workspaceId}/recordings/{recordingId}
Replace {workspaceId} and {recordingId} with your actual values from the Userplane dashboard URL bar.