Skip to main content

🖥️ Interactive Terminal MCP Server

PyPI version License: MIT

A fully interactive terminal MCP server for AI agents with TUI support, keyboard control, and screen capture - Cross-platform (Windows, Linux, Mac).

✨ Features

  • 🖥️ Full Terminal Control - Create, manage, and delete terminal sessions
  • ⌨️ Keyboard Support - Arrow keys, Ctrl, Alt, F-keys, PageUp/Down, etc.
  • 📺 TUI Applications - Works with htop, vim, nano, mc, and more
  • 🔄 Auto-Update - Automatically checks and installs updates from PyPI
  • 🌍 Cross-Platform - Windows (pywinpty), Linux/Mac (ptyprocess)

📦 Installation

pip install vitjas-interactive-terminal

🚀 Usage

Start the MCP Server

You can start the server in 3 ways:

# Option 1: Entry Point (recommended)
vitjas-interactive-terminal

# Option 2: Python Module
python -m interactive_terminal

# Option 3: Python3 Module (Linux/Mac)
python3 -m interactive_terminal

MCP Configuration

For Claude Desktop / Agent Zero:

Linux/Mac (Option A - Entry Point):

{
  "mcpServers": {
    "InteractiveTerminal": {
      "command": "vitjas-interactive-terminal",
      "args": [],
      "init_timeout": 30
    }
  }
}

Linux/Mac (Option B - Python3 Module):

{
  "mcpServers": {
    "InteractiveTerminal": {
      "command": "python3",
      "args": ["-m", "interactive_terminal"],
      "init_timeout": 30
    }
  }
}

Windows:

{
  "mcpServers": {
    "InteractiveTerminal": {
      "command": "python",
      "args": ["-m", "interactive_terminal"],
      "init_timeout": 30
    }
  }
}

🛠️ Available Tools

Tool Description
create_terminal Create a new interactive terminal session
send_text Send text/commands to a terminal
send_keys Send special keys (arrows, Ctrl+C, etc.)
get_screen Read terminal screen content
list_terminals List all active terminals
delete_terminal Delete/close a terminal
search_buffer Search through terminal history

⌨️ Supported Keys

  • Navigation: up, down, left, right, home, end, pageup, pagedown
  • Control: ctrl+c, ctrl+d, ctrl+z, ctrl+a, ctrl+e, ctrl+u, ctrl+k, ctrl+w, ctrl+l
  • Alt: alt+f, alt+b, alt+d
  • Other: enter, escape, tab, backspace, delete, f1-f12

💡 Examples

Navigate htop:

# Create terminal and start htop
create_terminal → send_text("htop\n") → get_screen()
# Navigate with arrow keys
send_keys("down") → send_keys("enter")
# Exit
send_keys("f10") or send_keys("q")

Edit with nano:

# Create and open file
create_terminal → send_text("nano test.txt\n")
# Type content
send_text("Hello World!")
# Save and exit
send_keys("ctrl+x") → send_text("Y") → send_keys("enter")

🔧 Configuration

Disable Auto-Update:

VITJAS_AUTO_UPDATE=false vitjas-interactive-terminal

📋 Requirements

  • Python >= 3.10
  • Windows: pywinpty >= 2.0.0 (auto-installed)
  • Linux/Mac: ptyprocess >= 0.7.0 (auto-installed)

🔗 Links

📜 License

MIT License - see LICENSE

👤 Author

Vltja - GitHub

Metadata

Release files for vitjas-interactive-terminal 1.2.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vitjas-interactive-terminal 1.2.6
File Size Uploaded Provenance Actions
vitjas_interactive_terminal-1.2.6.tar.gz 14.6 kB Without provenance Details for vitjas_interactive_terminal-1.2.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vitjas-interactive-terminal 1.2.6
File Interpreter ABI Platform Actions
vitjas_interactive_terminal-1.2.6-py3-none-any.whl Python 3 none any Details for vitjas_interactive_terminal-1.2.6-py3-none-any.whl

Total release size: 28.4 kB

Release files / vitjas_interactive_terminal-1.2.6.tar.gz

Download URL vitjas_interactive_terminal-1.2.6.tar.gz
Size 14.6 kB
Tags Source
SHA-256 checksum
How to use checksums
1499e21ddb0502fc0f06f4b68245fb33c56c043b62e3c01b33f03914596ba4b0
BLAKE2b-256 checksum
How to use checksums
c31097ad370b6a3823f25b49c98a88d7374af7a7f62876a9abbbfe94dd5798c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release files / vitjas_interactive_terminal-1.2.6-py3-none-any.whl

Download URL vitjas_interactive_terminal-1.2.6-py3-none-any.whl
Size 13.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
def9d9d65a8e51213f4b989c8bbf601c4ad3616fc65cebc0222607f3d63add15
BLAKE2b-256 checksum
How to use checksums
39b6fa036ffc89e9984c9cd30b78c054b0aceb69c56c947f31a3731ccd774dac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Security for vitjas-interactive-terminal 1.2.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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