Skip to main content
Glama

Start Recording

start_recording
Destructive

Start a background screen recording. Returns a session id; finalize it with stop_recording. Never auto-starts.

Instructions

Start a background screen recording. Returns a session id; finalize it with stop_recording. Never auto-starts.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "target": "<target>"
    },
    "name": "start_recording"
  }
}

Input Schema

NameRequiredDescriptionDefault
fpsNoFrames per second (default 30).
keysNoWith events: masked (default) logs typing only as 0.5 s-grid bursts, never keys; shortcuts also names Ctrl/Alt/Win chords. Typed text is never logged.
logsNoLog files to follow onto the video clock.
perfNoSample CPU/memory (and a window's app) to <rec>.perf.jsonl.
audioNoAudio (default none). No microphone capture.
focusNoLog app switches (implies events); title adds window titles.
cursorNoevents: leave the OS cursor out and log it (implies events) for the cursor tool to redraw.
eventsNoAlso log clicks, scroll, cursor, and typing (video-timed, video pixels) for read_events (default false; ~1 s slower start).
outputNoOutput .mp4 path (default under SCREENCAST_HOME/recordings).
targetYesfull | monitor:<i> (0 = primary) | window:<title> (or window:exe=<app.exe> / window:hwnd=<n>) | region:<x>,<y>,<w>,<h>. With gdigrab a window's rectangle is resolved once at start (visible, on top); it does not follow the window.
webcamNoAlso record a camera to <output>.webcam.mp4, aligned for overlay.
backendNogdigrab (default): the screen rectangle. wgc (window: targets, FFmpeg 8+): the window's own surface, even when covered or moved; client area only. ddagrab: one display on the GPU, low CPU.
encoderNoauto = first working GPU encoder, else x264 (default with ddagrab; else x264).
hotkeysNoCtrl+Alt+Shift+M adds a marker, +S stops (implies events).
qualityNoEncoder preset (default standard).
elementsNoName the UI element each click hits, e.g. "Save" button (implies events).
stopWhenNoStop once this text shows (OCR).
overwriteNoAllow replacing an existing file at the output path (default false).
startWhenNoArm: start once these hold (stop_recording disarms).
exactTitleNowindow: targets match the whole title only, never a substring (default false).
maxDurationSecNoAuto-stop after this many seconds (default 3600 or SCREENCAST_MAX_RECORDING_SEC; max 7 days; 0 = no cap).
replayBufferSecNoInstant replay: keep only the last N s (bounded disk) for save_replay. gdigrab or ddagrab, not wgc.

Output Schema

NameRequiredDescriptionDefault
statusYes
backendYes
sessionIdYes
outputPathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.51.1
    • changedInput schema / properties / backend / description
      Previous value: -"gdigrab (default): the screen rectangle. wgc (window: targets, FFmpeg 8+): the window's own surface, even when covered or moved; client area only, no audio. ddagrab: one display on the GPU, low CPU."New value: +"gdigrab (default): the screen rectangle. wgc (window: targets, FFmpeg 8+): the window's own surface, even when covered or moved; client area only. ddagrab: one display on the GPU, low CPU."
    • addedInput schema / properties / elements
      Added value: +{
      +  "description": "Name the UI element each click hits, e.g. \"Save\" button (implies events).",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / focus
      Added value: +{
      +  "description": "Log app switches (implies events); title adds window titles.",
      +  "enum": [
      +    "app",
      +    "title"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / hotkeys
      Added value: +{
      +  "description": "Ctrl+Alt+Shift+M adds a marker, +S stops (implies events).",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / logs
      Added value: +{
      +  "description": "Log files to follow onto the video clock.",
      +  "items": {
      +    "properties": {
      +      "label": {
      +        "maxLength": 40,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "path": {
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "path"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 5,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • addedInput schema / properties / perf
      Added value: +{
      +  "description": "Sample CPU/memory (and a window's app) to <rec>.perf.jsonl.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / startWhen
      Added value: +{
      +  "description": "Arm: start once these hold (stop_recording disarms).",
      +  "properties": {
      +    "text": {
      +      "description": "Text that must be on target (OCR).",
      +      "maxLength": 200,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "timeoutSec": {
      +      "description": "Default 600.",
      +      "exclusiveMinimum": 0,
      +      "maximum": 86400,
      +      "type": "number"
      +    },
      +    "window": {
      +      "description": "A window: target that must exist, e.g. \"window:Error\".",
      +      "minLength": 1,
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / stopWhen
      Added value: +{
      +  "description": "Stop once this text shows (OCR).",
      +  "properties": {
      +    "text": {
      +      "maxLength": 200,
      +      "minLength": 1,
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "text"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changedv0.48.0
    • changedInput schema / properties / replayBufferSec / description
      Previous value: -"Instant replay: keep only the last N s (bounded disk) for save_replay. gdigrab only."New value: +"Instant replay: keep only the last N s (bounded disk) for save_replay. gdigrab or ddagrab, not wgc."
  3. Changed16 schema fields changedv0.47.0
    • changedInput schema / properties / audio / description
      Previous value: -"Audio capture (default none, video-only). source 'system' needs a loopback device; microphone capture is not supported."New value: +"Audio (default none). No microphone capture."
    • changedInput schema / properties / audio / properties / device / description
      Previous value: -"Optional dshow loopback device name (from list_audio_devices). When omitted, a loopback device is auto-detected."New value: +"dshow loopback device (from list_audio_devices); auto-detected if omitted."
    • changedInput schema / properties / audio / properties / source / description
      Previous value: -"system captures what is playing on the machine; none is video-only."New value: +"system = what the machine plays (needs a loopback device); none = video only."
    • changedInput schema / properties / backend / description
      Previous value: -"gdigrab (default) records the screen rectangle. wgc (window: targets, FFmpeg 8+) records the window's own surface through Windows Graphics Capture: it keeps recording the window when it is covered, moved, or in the background, and frames only its client area. No audio with wgc."New value: +"gdigrab (default): the screen rectangle. wgc (window: targets, FFmpeg 8+): the window's own surface, even when covered or moved; client area only, no audio. ddagrab: one display on the GPU, low CPU."
    • changedInput schema / properties / backend / enum
      Previous value: -[
      -  "gdigrab",
      -  "wgc"
      -]New value: +[
      +  "gdigrab",
      +  "wgc",
      +  "ddagrab"
      +]
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "events: leave the OS cursor out and log it (implies events) for the cursor tool to redraw.",
      +  "enum": [
      +    "os",
      +    "events"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / encoder
      Added value: +{
      +  "description": "auto = first working GPU encoder, else x264 (default with ddagrab; else x264).",
      +  "enum": [
      +    "auto",
      +    "x264",
      +    "nvenc",
      +    "qsv",
      +    "amf"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / events / description
      Previous value: -"Also log mouse clicks, scroll, cursor positions, and typing to <recording>.events.jsonl, timed to the video and in video pixels (default false). Read it with read_events. Adds about a second to start."New value: +"Also log clicks, scroll, cursor, and typing (video-timed, video pixels) for read_events (default false; ~1 s slower start)."
    • changedInput schema / properties / exactTitle / description
      Previous value: -"For window: targets, match only a window whose title equals the given title (case-insensitive); never fall back to a substring match. Default false."New value: +"window: targets match the whole title only, never a substring (default false)."
    • changedInput schema / properties / keys / description
      Previous value: -"With events: masked (default) logs typing only as bursts (start and length on a 0.5 s grid), never which keys or when each one was pressed. shortcuts also names chords made with Ctrl, Alt, or Win (e.g. Ctrl+S), with their times; typed text is never logged."New value: +"With events: masked (default) logs typing only as 0.5 s-grid bursts, never keys; shortcuts also names Ctrl/Alt/Win chords. Typed text is never logged."
    • changedInput schema / properties / maxDurationSec / description
      Previous value: -"Stop automatically after this many seconds, finalizing the file (default 3600, or SCREENCAST_MAX_RECORDING_SEC; at most 604800, 7 days). 0 = no cap. A safety net against a recording that is never stopped."New value: +"Auto-stop after this many seconds (default 3600 or SCREENCAST_MAX_RECORDING_SEC; max 7 days; 0 = no cap)."
    • changedInput schema / properties / output / description
      Previous value: -"Optional output .mp4 path. Defaults to a file under SCREENCAST_HOME/recordings."New value: +"Output .mp4 path (default under SCREENCAST_HOME/recordings)."
    • addedInput schema / properties / replayBufferSec
      Added value: +{
      +  "description": "Instant replay: keep only the last N s (bounded disk) for save_replay. gdigrab only.",
      +  "maximum": 3600,
      +  "minimum": 4,
      +  "type": "integer"
      +}
    • changedInput schema / properties / target / description
      Previous value: -"Capture target: 'full' | 'monitor:<index>' (0 = primary) | 'window:<title>' (or window:exe=<app.exe> / window:hwnd=<handle>, without relying on the title) | 'region:<x>,<y>,<w>,<h>' (absolute pixels). window: records the on-screen rectangle the window occupies, resolved ONCE at start (it must be visible, on top, not minimized); it does not follow a window moved or resized mid-recording."New value: +"full | monitor:<i> (0 = primary) | window:<title> (or window:exe=<app.exe> / window:hwnd=<n>) | region:<x>,<y>,<w>,<h>. With gdigrab a window's rectangle is resolved once at start (visible, on top); it does not follow the window."
    • addedInput schema / properties / webcam
      Added value: +{
      +  "description": "Also record a camera to <output>.webcam.mp4, aligned for overlay.",
      +  "properties": {
      +    "corner": {
      +      "enum": [
      +        "top_left",
      +        "top_right",
      +        "bottom_left",
      +        "bottom_right"
      +      ],
      +      "type": "string"
      +    },
      +    "device": {
      +      "description": "list_video_devices name (default: first).",
      +      "type": "string"
      +    },
      +    "shape": {
      +      "enum": [
      +        "rect",
      +        "circle"
      +      ],
      +      "type": "string"
      +    },
      +    "size": {
      +      "description": "Share of width (0.25).",
      +      "maximum": 0.5,
      +      "minimum": 0.1,
      +      "type": "number"
      +    }
      +  },
      +  "type": "object"
      +}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "backend": {
      +      "type": "string"
      +    },
      +    "outputPath": {
      +      "type": "string"
      +    },
      +    "sessionId": {
      +      "type": "string"
      +    },
      +    "status": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "sessionId",
      +    "status",
      +    "backend",
      +    "outputPath"
      +  ],
      +  "type": "object"
      +}
  4. Changed4 schema fields changedv0.39.0
    • changedInput schema / properties / events / description
      Previous value: -"Also log mouse clicks, scroll, cursor positions, and key presses to <recording>.events.jsonl, timed to the video and in video pixels (default false). Read it with read_events. Adds about a second to start."New value: +"Also log mouse clicks, scroll, cursor positions, and typing to <recording>.events.jsonl, timed to the video and in video pixels (default false). Read it with read_events. Adds about a second to start."
    • changedInput schema / properties / keys / description
      Previous value: -"With events: masked (default) logs that a key was pressed, never which. shortcuts also names chords made with Ctrl, Alt, or Win (e.g. Ctrl+S); typed text is never logged."New value: +"With events: masked (default) logs typing only as bursts (start and length on a 0.5 s grid), never which keys or when each one was pressed. shortcuts also names chords made with Ctrl, Alt, or Win (e.g. Ctrl+S), with their times; typed text is never logged."
    • changedInput schema / properties / maxDurationSec / description
      Previous value: -"Stop automatically after this many seconds, finalizing the file (default 3600, or SCREENCAST_MAX_RECORDING_SEC). 0 = no cap. A safety net against a recording that is never stopped."New value: +"Stop automatically after this many seconds, finalizing the file (default 3600, or SCREENCAST_MAX_RECORDING_SEC; at most 604800, 7 days). 0 = no cap. A safety net against a recording that is never stopped."
    • changedInput schema / properties / maxDurationSec / maximum
      Previous value: -9007199254740991New value: +604800
  5. First observedv0.32.0

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and readOnlyHint=false, and the description adds useful lifecycle detail (returns a session id, must be finalized with stop_recording). However, it never mentions that an existing file at the output path will not be replaced unless overwrite is set, nor does it clarify recording length caps or the cleanup consequences of not calling stop_recording. 'Never auto-starts' is ambiguous given the startWhen arming parameter.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences with the primary action front-loaded, then the lifecycle contract, then a caveat. No filler or redundant restatement of the name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists and the schema fully documents all parameters, so the description does not need to explain fields or return values. It covers the essential start/finalize cycle; the only shortfall is that the ambiguous 'Never auto-starts' clause is left unexplained.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all 22 parameters, including nested audio, webcam, logs, and startWhen/stopWhen objects, are already documented in the schema. The description adds no additional parameter meaning, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Start a background screen recording') and names the pairing tool (stop_recording) for finalization. It is clearly distinguishable from sibling tools like pause_recording or resume_recording, but the closing phrase 'Never auto-starts' is vague about what it modifies.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tells the agent the lifecycle: call this to begin, then finalize with stop_recording, which routes the agent correctly. It does not address when to prefer pause_recording/resume_recording or when replay-buffer mode should be chosen instead of a normal recording.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.