Skip to main content
Glama

read_output

Read-only

Retrieve new output from a running command without sending input. Use after a partial status to continue monitoring long-running processes.

Instructions

Read new output from a running command without sending any input.
Use this after execute returns status "partial" when the command needs no
interaction (e.g. long-running build, training loop, find).

Returns the same dict as execute:
  status="partial":    output + command_id; poll again for more.
  status="completed":  output + exit_code. The command_id is now spent —
                       it is closed and removed, so a later read_output on
                       it raises "Invalid command_id".
Each call returns only the output produced since the previous call.

Args:
- pause_timeout: seconds of OUTPUT SILENCE before returning (default 9.0).
  This is the dial that controls how long a silent-poll call waits.
  Raise it (e.g. 30, 60) when polling a very quiet job; raising
  total_timeout instead does nothing while the process stays silent.
- total_timeout: hard cap on call duration (default 20.0). Only binds
  while output is actively streaming.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
command_idYesThe active command_id returned in a partial status response
pause_timeoutNoSeconds of output silence to wait before returning (default is 9.0)
total_timeoutNoHard cap in seconds on the maximum duration of this call (default is 20.0)
Behavior5/5

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

Discloses that each call returns only new output, the returned dict structure (status partial/completed with output and exit_code), and that command_id is closed after completion. Annotations already indicate readOnlyHint, but description adds lifecycle details.

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?

Well-structured with a clear purpose statement, usage guidance, and parameter explanations. The bullet-like formatting for return types is effective. Slightly verbose but every sentence adds value.

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?

For a read-only tool with 3 parameters and no output schema, the description covers the return format (same as execute), command lifecycle, and timeout behaviors. It is complete enough for an agent to use correctly.

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

Parameters4/5

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

Schema covers all three parameters with descriptions. The description adds nuance: pause_timeout controls output silence wait and is the 'dial' for silent polling, while total_timeout only applies during active streaming. This enhances understanding beyond schema.

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

Purpose5/5

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

The description clearly states 'Read new output from a running command without sending any input' using a specific verb and resource. It distinguishes itself from sibling tools like execute and respond by emphasizing it does not send input.

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

Usage Guidelines5/5

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

The description explicitly says to use after execute returns 'partial' and when no interaction is needed (e.g., long-running builds). It also explains that after completion, the command_id becomes spent, preventing misuse.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/QiuwenZheng/interminal'

If you have feedback or need assistance with the MCP directory API, please join our Discord server