Skip to main content
Glama

term_read

Read new terminal output from a VMware guest session, wait for a matching pattern, or capture the full screen to monitor command progress and detect expected results.

Instructions

Read new output (delta), wait for a regex (until), or render the screen (mode=screen).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNodelta
cleanNoStrip terminal control sequences
untilNoRegex to wait for (delta mode)
cursorNoAbsolute cursor; omit to continue
timeoutNoSeconds to wait when until is set
max_bytesNo
session_idYesSession id from term_open

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It mentions waiting for a regex (implying blocking) but does not disclose cursor advancement, cleanup behavior, non-destructive nature, or what happens on timeout. The description is too terse to convey side effects or operational semantics.

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?

The description is a single, front-loaded sentence that captures the core functionality with no redundant words. It is appropriately sized for a simple summary, though it sacrifices depth for brevity.

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

Completeness2/5

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

Given the tool's complexity (7 params, no output schema, no annotations), the description is incomplete. It omits return format, blocking behavior, cursor semantics, and when to use which mode. An agent would need to rely heavily on the schema and prior experience to use 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 71%, so the schema already documents most parameters. The description adds meaning by linking 'delta' and 'until' to modes, and 'screen' to rendering, which helps interpret mode and until. However, it does not explain cursor, timeout, or max_bytes beyond their schema descriptions, so it only partially compensates.

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 clearly states the tool reads new output (delta), waits for a regex (until), or renders the screen (mode=screen), giving a specific verb and resource. It distinguishes between three modes but does not explicitly tie it to a terminal session, though the name and session_id parameter imply it.

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

Usage Guidelines2/5

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

The description implies usage for reading terminal output but does not explain when to prefer this over siblings like term_list (list sessions) or term_send (write). No exclusions or alternative routing are provided, leaving an agent to infer when this is the appropriate tool.

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