Skip to main content

MCP Server providing fully interactive terminal sessions for AI agents - TUI support, keyboard control, screen capture

Project description

Vitjas Interactive Terminal MCP Server

A Model Context Protocol (MCP) server providing fully interactive terminal sessions for AI agents.

🎯 Purpose

This server enables AI agents to interact with any command-line application, including:

  • TUI applications: htop, top, btop, ncdu, nmtui, etc.
  • Text editors: nano, vim, emacs
  • Pagers: less, more
  • File managers: midnight commander (mc), ranger
  • Interactive CLIs: python REPL, node REPL, mysql, psql
  • Long-running processes: downloads, builds, tests

✨ Key Features

  • 🖥️ True Interactive Terminals - Not just command execution!
  • ⌨️ Full Keyboard Support - Arrow keys, Ctrl, Alt, Function keys
  • 📜 Scrollback History - 50,000 lines of history
  • 🔄 Session Persistence - Terminals persist between commands
  • 📊 Screen Capture - Read terminal output anytime
  • 🎮 TUI Navigation - Navigate menus, lists, editors
  • 🔍 Buffer Search - Search through terminal history

📦 Installation

From PyPI (Recommended)

pip install vitjas-interactive-terminal

Prerequisites

# Ensure tmux is installed
apt-get install tmux    # Debian/Ubuntu
brew install tmux        # macOS

⚙️ Configuration

For Claude Desktop / Agent Zero

Add to your MCP configuration:

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

No paths needed! After pip install, the command is available system-wide.

🔧 Available Tools

Tool Description
create_terminal Create a new interactive terminal session
send_text Send text/commands to terminal
send_keys Send special keys (arrows, Ctrl, Alt, F-keys)
get_screen Read terminal output with metadata
list_terminals List all active terminal sessions
delete_terminal Close/delete a terminal session
search_buffer Search through terminal history

⌨️ Supported Keys for send_keys

Category Keys
Navigation up, down, left, right, home, end, pageup, pagedown
Control ctrl+a through ctrl+z, ctrl+c (interrupt), ctrl+d (EOF)
Alt alt+a through alt+z
Special enter, escape, tab, backspace, delete, f1-f12

💡 Usage Examples

Run a Simple Command

1. create_terminal(directory="/home/user")
2. send_text("ls -la\n")
3. get_screen()  # See the directory listing

Navigate htop

1. create_terminal()
2. send_text("htop\n")
3. send_keys("down")    # Move selection down
4. send_keys("enter")   # View process details
5. send_keys("q")       # Quit htop

Edit File in nano

1. create_terminal(directory="/tmp")
2. send_text("nano myfile.txt\n")
3. send_text("Hello World!")
4. send_keys("ctrl+o")  # Save
5. send_keys("enter")   # Confirm filename
6. send_keys("ctrl+x")  # Exit

🔧 Technical Details

  • Backend: tmux sessions
  • History: 50,000 lines scrollback
  • Default size: 120 cols × 40 rows
  • Session persistence: Until deleted or server restart

📄 License

MIT License

Project details


Download files

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

Source Distribution

vitjas_interactive_terminal-1.1.0.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

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

vitjas_interactive_terminal-1.1.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file vitjas_interactive_terminal-1.1.0.tar.gz.

File metadata

File hashes

Hashes for vitjas_interactive_terminal-1.1.0.tar.gz
Algorithm Hash digest
SHA256 4db2ebd4f7e7c18796d37f5a5d94a4c1b0eaf3cdc303c2f4772cdd5800c370f3
MD5 cfb64995d58b24b6c559c33fe4cd6bb7
BLAKE2b-256 d106ad607b96c57a4fbb0127a18f39c746ae522c12fcb056c7a71921e8f0d6f5

See more details on using hashes here.

File details

Details for the file vitjas_interactive_terminal-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for vitjas_interactive_terminal-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9059fd69438b7f56eac728d6f00efa9b07f0386b8cb457c93b332c25261b3db8
MD5 c22f0151d5c805c276a05196d82f4376
BLAKE2b-256 33bd9b6dc632850843a63745b9d658043b9631387686cacb15a8b29f661d95e9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page