Skip to main content
Glama

Read Input Events

read_events
Read-onlyIdempotent

Read the input events (clicks, scroll, cursor, shortcuts, typing bursts) of a recording made with events: true, in video seconds and pixels; e.g. types: ['down'], then sample_frames there.

Instructions

Read the input events (clicks, scroll, cursor, shortcuts, typing bursts) of a recording made with events: true, in video seconds and pixels; e.g. types: ['down'], then sample_frames there.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read_events"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoLatest video second.
fromNoEarliest video second.
inputNoOr a recording path, or its .events.jsonl.
limitNoMost events to return (default 200).
typesNodown/up (mouse buttons; clicks are down), move (sampled cursor), wheel, key (shortcut), typing (burst), gap (events may be missing).
sessionIdNoSession id of a recording started with events: true.
inFrameOnlyNoDrop events whose cursor was outside the recorded area.

Output Schema

NameRequiredDescriptionDefault
totalYes
matchedYes
summaryYes
returnedYes
eventsPathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.51.1
    • changedInput schema / properties / types / items / enum
      Previous value: -[
      -  "down",
      -  "up",
      -  "move",
      -  "wheel",
      -  "key",
      -  "typing",
      -  "gap"
      -]New value: +[
      +  "down",
      +  "up",
      +  "move",
      +  "wheel",
      +  "key",
      +  "typing",
      +  "gap",
      +  "focus"
      +]
  2. Changed6 schema fields changedv0.47.0
    • changedInput schema / properties / from / description
      Previous value: -"Only events at or after this video time, in seconds."New value: +"Earliest video second."
    • changedInput schema / properties / input / description
      Previous value: -"Or a recording path (its sibling .events.jsonl is read) or the .events.jsonl itself."New value: +"Or a recording path, or its .events.jsonl."
    • changedInput schema / properties / limit / description
      Previous value: -"Most events to return (default 200); the result says when more matched."New value: +"Most events to return (default 200)."
    • changedInput schema / properties / to / description
      Previous value: -"Only events at or before this video time, in seconds."New value: +"Latest video second."
    • changedInput schema / properties / types / description
      Previous value: -"Only these types: down / up (mouse buttons), move (sampled cursor), wheel, key (a named shortcut), typing (a burst of typing: start and length only), gap (events may be missing). Clicks are down."New value: +"down/up (mouse buttons; clicks are down), move (sampled cursor), wheel, key (shortcut), typing (burst), gap (events may be missing)."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "eventsPath": {
      +      "type": "string"
      +    },
      +    "matched": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "returned": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "summary": {
      +      "additionalProperties": {
      +        "type": "number"
      +      },
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "total": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "eventsPath",
      +    "total",
      +    "matched",
      +    "returned",
      +    "summary"
      +  ],
      +  "type": "object"
      +}
  3. Changed2 schema fields changedv0.39.0
    • changedInput schema / properties / types / description
      Previous value: -"Only these types: down / up (mouse buttons), move (sampled cursor), wheel, key. Clicks are down."New value: +"Only these types: down / up (mouse buttons), move (sampled cursor), wheel, key (a named shortcut), typing (a burst of typing: start and length only), gap (events may be missing). Clicks are down."
    • changedInput schema / properties / types / items / enum
      Previous value: -[
      -  "down",
      -  "up",
      -  "move",
      -  "wheel",
      -  "key"
      -]New value: +[
      +  "down",
      +  "up",
      +  "move",
      +  "wheel",
      +  "key",
      +  "typing",
      +  "gap"
      +]
  4. First observedv0.32.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare this a read-only, idempotent, non-destructive, closed-world operation, so the bar is lower. The description still adds value beyond them: events are reported in video seconds and pixels, and 'gap' events signal that events may be missing, which an agent would not learn from annotations or schema alone.

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

Conciseness4/5

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

It is a single dense sentence that front-loads purpose and event kinds before the types example. Nothing is wasted, though the semicolon-clause structure makes it slightly harder to scan than a two-sentence form.

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

Completeness5/5

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

With an output schema present, annotations covering safety, and full schema coverage of all seven optional parameters, the description supplies exactly the missing pieces: the events:true prerequisite, the coordinate units, and the gap semantics. An agent has everything needed to call it correctly.

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 the baseline is 3. The description reinforces units (video seconds and pixels) and gives a concrete example of types: ['down'], but that largely restates what the schema already documents for from/to and types.

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?

The description names a specific verb and resource (read input events) and enumerates the event kinds returned (clicks, scroll, cursor, shortcuts, typing bursts), plus the coordinate space. It is clear enough to distinguish from a generic media reader, though it does not explicitly contrast itself with siblings like cursor or sample_frames.

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

Usage Guidelines3/5

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

A real prerequisite is stated: the recording must have been made with events: true, which is genuine when-to-use context. However, there are no when-not conditions and no explicit routing to alternatives such as cursor for live cursor data; the mention of sample_frames is a follow-up hint rather than an alternative-selection rule.

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