Skip to main content
Glama
HLH2023
by HLH2023

terminal.mouse_scroll

Scroll terminal TUI content (chat logs, file viewers) by simulating mouse wheel events at specified column and row positions. Requires mouse mode enabled in the target program.

Instructions

Scroll the mouse wheel at a specific position in the terminal. Sends SGR-1006 scroll sequences that interactive TUI programs understand. Useful for scrolling through long content in TUI apps (chat history, logs, file viewers). The child process must have mouse mode enabled for scroll events to take effect.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sessionIdYesSession ID from terminal.start — use exact value
colYes1-based column (x position, left=1)
rowYes1-based row (y position, top=1)
directionYesScroll direction
linesNoNumber of scroll ticks (1-20, each ~3 lines)
shiftNoShift key held (fast scroll in some apps)
altNoAlt key held
ctrlNoCtrl key held
Behavior3/5

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

No annotations, so description carries full burden. It discloses the mechanism (SGR-1006 scroll sequences) and a key condition (mouse mode required). However, lacks details on side effects, error behavior, or return values. Adequate but not comprehensive.

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?

Three sentences, zero waste. First sentence states action, second provides technical detail, third gives use case and prerequisite. Front-loaded and efficient.

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

Completeness4/5

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

Covers mechanism, prerequisite, and typical use. No output schema needed. Could mention failure modes (e.g., mouse mode disabled) but overall sufficient given tool complexity.

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 coverage is 100%, so baseline is 3. Description does not add meaning beyond parameter names and types in schema. It restates concepts like 'specific position' which are already clear from 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 the tool scrolls the mouse wheel at a specific position, using SGR-1006 sequences for interactive TUI programs. It distinguishes from sibling tools like terminal.scroll by specifying mouse wheel and TUI context.

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

Usage Guidelines4/5

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

Provides context: useful for scrolling through long content in TUI apps. Includes prerequisite that child process must have mouse mode enabled. Does not explicitly compare to alternatives or state when not to use, but gives sufficient situational guidance.

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/HLH2023/terminal-use-mcp'

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