Skip to main content
Glama

tty

Read-only

Detect whether stdin is connected to a terminal and return the terminal device path, enabling distinction between interactive and piped execution contexts.

Instructions

Check if stdin is connected to a terminal and return the terminal device path. Read-only, no side effects. Returns JSON with the TTY path and connection status; exits non-zero if not a TTY. Use to detect interactive vs. piped execution contexts. Not for terminal configuration — use 'stty' for terminal settings. See also 'stty'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
exit_codeNoReturn exit code 1 when stdin is not a TTY.
rawNoWrite tty path or 'not a tty' without a JSON envelope.
Behavior4/5

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

Annotations already provide readOnlyHint=true. The description adds behavioral details: returns JSON with TTY path and connection status, exits non-zero if not a TTY. No contradiction with annotations.

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, each adding value. Front-loaded with the core purpose. No redundant or extraneous information.

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?

The tool is simple, schema thoroughly documents parameters, no output schema needed. Description covers purpose, usage, behavior, and alternatives. Complete for the tool's 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 the schema already explains the two parameters. The description does not add parameter-specific meaning beyond the schema, meeting the baseline 3.

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 checks if stdin is connected to a terminal and returns the device path, with a specific verb and resource. It distinguishes from sibling 'stty' by noting it's not for terminal configuration.

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 when to use (detect interactive vs. piped execution) and when not (terminal configuration), and names the alternative tool 'stty'.

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/caseSHY/AI-CLI'

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