Skip to main content

terminal-mcp banner

Give your AI a real terminal. Persistent sessions. Interactive programs. Zero limitations.

PyPI Python 3.10+ License: MIT CI CodeQL

Install in VS Code Install in VS Code Insiders Install in Cursor Install in Claude Desktop

terminal-mcp demo


The Problem

Every AI coding tool hits the same wall: no real terminal access.

Claude Code's Bash tool, GitHub Copilot, and Codex all run commands in isolated subprocesses. Each command starts fresh. No state carries over. That means:

  • No SSH sessions - Can't connect to a remote server and run multiple commands
  • No REPLs - Can't use Python, Node, or Ruby interpreters interactively
  • No database CLIs - Can't maintain a psql, mysql, or redis-cli connection
  • No TUI apps - Can't navigate htop, vim, or fzf with arrow keys
  • No long-running processes - Can't monitor builds, watch logs, or run dev servers

The Solution

terminal-mcp gives AI agents a real terminal. Persistent PTY sessions that survive across tool calls. Send commands, read output, press keys, navigate TUIs - exactly like a human at a terminal.

uvx terminal-mcp

One command. Works with Claude Code, Claude Desktop, VS Code, Cursor, and Windsurf.


Quick Start

1. Install (30 seconds)

# No install needed - run directly
uvx terminal-mcp

# Or install globally
pip install terminal-mcp

2. Connect to Your AI Client

Claude Code

Add to ~/.claude.json or project .mcp.json:

{
  "mcpServers": {
    "terminal": {
      "command": "uvx",
      "args": ["terminal-mcp"]
    }
  }
}
Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "terminal": {
      "command": "uvx",
      "args": ["terminal-mcp"]
    }
  }
}
VS Code / Cursor

Click the one-click install badge above, or add to .vscode/mcp.json:

{
  "servers": {
    "terminal-mcp": {
      "command": "uvx",
      "args": ["terminal-mcp"]
    }
  }
}
Windsurf

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "terminal": {
      "command": "uvx",
      "args": ["terminal-mcp"]
    }
  }
}

3. Verify

session_exec  exec="echo hello from terminal-mcp"

What Can You Do With It?

SSH Into Remote Servers

session_create   command="ssh user@prod-server.com"   label="prod"
session_interact session_id="a1b2c3d4"  input="df -h"  wait_for="\$"
session_interact session_id="a1b2c3d4"  input="docker ps"  wait_for="\$"
session_close    session_id="a1b2c3d4"

Run Interactive REPLs

session_create   command="python3"  label="python"
session_interact session_id="e5f6g7h8"  input="import pandas as pd"  wait_for=">>>"
session_interact session_id="e5f6g7h8"  input="df = pd.read_csv('data.csv')"  wait_for=">>>"
session_interact session_id="e5f6g7h8"  input="df.describe()"  wait_for=">>>"
session_close    session_id="e5f6g7h8"

Query Databases

session_create   command="psql -U admin mydb"  label="db"
session_interact session_id="x1y2z3w4"  input="SELECT count(*) FROM users;"  wait_for="row"
session_interact session_id="x1y2z3w4"  input="\dt"  wait_for="#"
session_close    session_id="x1y2z3w4"

Navigate TUI Apps

session_create   command="htop"  label="monitor"
session_read     session_id="a1b2c3d4"
# Auto-detects TUI, returns screen snapshot

session_send     session_id="a1b2c3d4"  key="F6"
session_read     session_id="a1b2c3d4"  mode="diff"
# Returns only changed lines - saves tokens

session_send     session_id="a1b2c3d4"  key="F10"
session_close    session_id="a1b2c3d4"

Monitor Long-Running Builds

session_create   command="bash"  label="build"
session_send     session_id="a1b2c3d4"  input="npm run build"
session_wait_for session_id="a1b2c3d4"  pattern="Build complete|ERROR"  timeout=120

Run One-Off Commands

session_exec  exec="git log --oneline -10"
session_exec  exec="docker compose ps"  timeout=10

Features at a Glance

Feature What It Does
Persistent Sessions Real PTY sessions that survive across tool calls
Send + Read in One Call session_interact halves LLM round trips
Pattern-Based Reads wait_for blocks until regex matches - no guessing timeouts
Auto TUI Detection Detects htop, vim, etc. and auto-switches to screen snapshot mode
Output Diff Mode Returns only changed screen lines - minimizes tokens
Special Keys Arrow keys, Tab, F1-F12, Home/End, Page Up/Down
Control Characters Ctrl-C, Ctrl-D, Ctrl-Z, Ctrl-L, telnet escape
Dangerous Command Gate Blocks rm -rf, DROP TABLE, curl|sh - requires confirmation
OSC 133 Shell Integration Auto-detects command boundaries and exit codes
Smart Truncation Four strategies to prevent context overflow
Secret Input Send passwords without logging
Dynamic Resize Resize terminal on the fly with SIGWINCH
Idle Cleanup Auto-closes idle sessions
Cross-Platform Linux, macOS, and Windows support

Tools Reference

terminal-mcp exposes 9 MCP tools. Full details in docs/tools.md.

Tool Purpose
session_create Spawn a persistent terminal session
session_send Send text, keys, or control characters
session_read Read output (stream, snapshot, auto, diff modes)
session_interact Send + read in one call
session_wait_for Wait for regex pattern in output
session_exec One-shot command execution
session_close Close a session gracefully
session_resize Resize terminal dimensions
session_list List active sessions

Architecture

flowchart LR
    Client[AI Client] -->|MCP JSON-RPC| Server[terminal-mcp]
    Server --> SM[Session Manager]
    SM --> S1[PTY 1: bash]
    SM --> S2[PTY 2: python3]
    SM --> S3[PTY 3: ssh user@host]
    S1 & S2 & S3 -.->|PTY output| Reader[Reader Thread]
    Reader -.->|buffer| Server

Each session is backed by a real PTY via pexpect.spawn (or PopenSpawn on Windows). For full architecture details, see docs/architecture.md.


Configuration

All settings configurable via TERMINAL_MCP_* environment variables. Full reference in docs/configuration.md.

Setting Env Var Default
Max sessions TERMINAL_MCP_MAX_SESSIONS 10
Idle timeout TERMINAL_MCP_IDLE_TIMEOUT 1800 (30 min)
Safety gate TERMINAL_MCP_SAFETY_GATE on
Buffer cap TERMINAL_MCP_MAX_BUFFER_BYTES 1000000 (1MB)
Truncation TERMINAL_MCP_TRUNCATION_MODE tail

Example with custom settings:

{
  "mcpServers": {
    "terminal": {
      "command": "uvx",
      "args": ["terminal-mcp"],
      "env": {
        "TERMINAL_MCP_MAX_SESSIONS": "20",
        "TERMINAL_MCP_IDLE_TIMEOUT": "3600",
        "TERMINAL_MCP_TRUNCATION_MODE": "head_tail"
      }
    }
  }
}

Documentation

Document Description
Tools Reference Complete API for all 9 MCP tools
Architecture How terminal-mcp works under the hood
Configuration All settings and environment variables
Safety & Security Dangerous command detection and safety gate
Use Cases & Examples Real-world recipes and patterns
Changelog Version history and release notes
Contributing How to contribute

Supported Clients

Client Status Install
Claude Code (CLI) Supported ~/.claude.json or .mcp.json
Claude Desktop Supported One-click install
VS Code (Copilot Chat) Supported One-click install or .vscode/mcp.json
Cursor Supported One-click install or Settings
Windsurf Supported ~/.codeium/windsurf/mcp_config.json

Running Tests

pip install -e ".[dev]"
pytest tests/ -v

Contributing

Contributions welcome! See docs/contributing.md for guidelines.

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terminal_mcp-0.4.7.tar.gz (47.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

terminal_mcp-0.4.7-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file terminal_mcp-0.4.7.tar.gz.

File metadata

  • Download URL: terminal_mcp-0.4.7.tar.gz
  • Upload date:
  • Size: 47.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for terminal_mcp-0.4.7.tar.gz
Algorithm Hash digest
SHA256 6ca25b4bd09d71914d7c17af5c65b0b98d9682e6f05645d9a2ef70224e551d17
MD5 c2af9081d44e0facbb79bd43e0870d26
BLAKE2b-256 bf1dd7279f2fffd852b21ddd504168d36820639e1b5ab94d371586df2d04ccd4

See more details on using hashes here.

Provenance

The following attestation bundles were made for terminal_mcp-0.4.7.tar.gz:

Publisher: release.yml on mkpvishnu/terminal-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file terminal_mcp-0.4.7-py3-none-any.whl.

File metadata

  • Download URL: terminal_mcp-0.4.7-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for terminal_mcp-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 70cbf15e271a682b4fc97f35351951156b86a2d31ac7bfa69b57df81be99f2de
MD5 f225f8a9871ada88753f8d40bb293682
BLAKE2b-256 87f25253945255bedcf639796e1ab9921e2c219f202e24a66954cc222025ee98

See more details on using hashes here.

Provenance

The following attestation bundles were made for terminal_mcp-0.4.7-py3-none-any.whl:

Publisher: release.yml on mkpvishnu/terminal-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.4.7 This release

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page