Skip to main content
Glama
Sign In
tui-mcp

tui-mcp

by nvms
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

Read Region

read_region

Extract text from a specific rectangular area of the terminal buffer using coordinates and dimensions.

Instructions

Read a rectangular region of the terminal buffer as text.

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": {
      "sessionId": "<sessionId>",
      "row": "<row>",
      "col": "<col>",
      "width": "<width>",
      "height": "<height>"
    },
    "name": "read_region"
  }
}

Input Schema

NameRequiredDescriptionDefault
sessionIdYesSession ID
rowYesStarting row (0-based)
colYesStarting column (0-based)
widthYesWidth in columns
heightYesHeight in rows

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions reading text but doesn't cover critical aspects like whether this requires specific permissions, if it's a read-only operation (implied but not stated), error handling (e.g., invalid coordinates), or performance characteristics. This leaves significant gaps for an agent to understand how to use it safely and effectively.

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?

The description is a single, efficient sentence that directly states the tool's function without any fluff. It's front-loaded with the core action and resource, making it easy to parse quickly.

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 complexity of a terminal interaction tool with 5 required parameters and no output schema, the description is insufficient. It lacks information about return values (e.g., format of the text, error responses), behavioral context (as noted in transparency), and usage guidelines. This makes it incomplete for an agent to reliably invoke the tool.

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 fully documents all 5 parameters (sessionId, row, col, width, height). The description adds no additional meaning beyond implying a rectangular region, which is already clear from the parameter names. This meets the baseline for high schema coverage.

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 action ('Read') and resource ('rectangular region of the terminal buffer as text'), making the purpose immediately understandable. It doesn't explicitly differentiate from siblings like 'screenshot' or 'wait_for_text', but the specificity of reading text from a defined region is reasonably distinct.

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 is provided on when to use this tool versus alternatives like 'screenshot' (which might capture visual output) or 'wait_for_text' (which monitors for text). The description only states what it does, not when it's appropriate or what prerequisites might exist (e.g., needing an active session).

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

Deploy Server

Other Tools