Skip to main content
Glama
sumchattering

iTerm2 MCP Server

iterm2_read_pane

Read the on-screen text from a specific iTerm2 terminal pane to capture its current output. Provide the pane's session ID to retrieve the visible buffer contents for inspection or further processing.

Instructions

Read the screen buffer contents of a specific iTerm2 pane. Returns the visible text in the terminal.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
session_idYesThe pane ID - use shorthand like 't5p2' (tab 5, pane 2) or 'w1t5p2' (window 1, tab 5, pane 2). Numbers are 1-based to match iTerm2's UI.
Behavior2/5

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

No annotations provided, so the description carries full burden. It states the tool reads the screen buffer and returns visible text, which implies a read-only operation, but doesn't clarify details like whether this captures scrollback or only the currently visible viewport, whether the text is cleared/stale, or if there are timing implications for reading live terminal output.

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?

Two concise sentences with zero waste. States the action and what's returned. Could arguably be a single sentence, but the brevity is appropriate for such a simple tool.

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

Completeness3/5

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

For a single-parameter read tool with no output schema, the description covers the basic purpose. However, it doesn't clarify the return format (is it raw text, lines, structured?), whether scrollback is included, or how this differs from iterm2_status for reading pane content. Given the tool's simplicity, this is adequate but not rich.

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 schema already clearly documents session_id with examples of shorthand formats. The description doesn't add meaning beyond the schema, but since coverage is complete, baseline 3 is appropriate.

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?

Clear verb+resource: 'Read the screen buffer contents of a specific iTerm2 pane.' This distinguishes from siblings like iterm2_send_text (which writes) and iterm2_list_panes (which enumerates). It's specific about what it does but doesn't elaborate on output format beyond saying visible text is returned.

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?

No guidance on when to use this tool versus alternatives like iterm2_current_pane or iterm2_status. It's implied that this is for reading terminal output, but there's no explicit when/when-not guidance or mention of alternatives for different reading scenarios.

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/sumchattering/iterm2-mcp-server'

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