Console Automation

You can harness this Production-Ready MCP Server to fully automate and monitor console applications. It enables real-time interaction with terminal sessions, robust error detection, streaming output, and scalable management of multiple concurrent consoles so you can build reliable terminal workflows and automation pipelines across local and remote environments.

How to use

Install or include the MCP server in your client, then start a local stdio MCP connection that exposes console methods you can call from your automation scripts. Create, control, and monitor multiple sessions, send text input or special keys, and stream or query output with filtering and pattern matching. Use the provided tools to detect errors, validate exit codes, and run long-running commands in the background with progress and results captured.

How to install

Prerequisites: Node.js 18 or newer. You may also work with npm or npx as your package manager.

# Windows, macOS, or Linux
# Quick start by pulling the MCP server package (example usage)
npm install --production

Configuration and usage notes

Configure your MCP client to connect through the available stdio entry. The provided example shows a local stdio connection using npm/npx to run the MCP server side.

{
  "mcpServers": {
    "console_automation": {
      "command": "npx",
      "args": ["@mcp/console-automation"],
      "env": {
        "LOG_LEVEL": "info"
      }
    }
  }
}

Examples of practical usage

Create a local session to run a dev server, wait for a startup message, and monitor for errors.

Run a background build task, then poll for completion and retrieve the result.

Troubleshooting tips

If a session stops responding, check whether the invoked command requires TTY interaction or has interactive prompts that need input.

Ensure you have the necessary permissions to spawn subprocesses and that any required dependencies are installed on the host system.

Available tools

console_create_session

Create a new local or SSH console session with a command and arguments.

console_send_input

Send text input to an active session, including keystrokes and command line data.

console_send_key

Send special keys (Enter, Tab, Ctrl+C, etc.) to an active session.

console_get_output

Retrieve filtered or paginated output from a session with optional regex matching.

console_get_stream

Stream real-time output from long-running processes for live monitoring.

console_wait_for_output

Wait for the session output to match a given pattern within a timeout.

console_stop_session

Terminate a session gracefully or forcefully.

console_list_sessions

List all currently active sessions.

console_cleanup_sessions

Clean up inactive or terminated sessions.

console_execute_command

Execute a command and capture its output and exit code.

console_detect_errors

Analyze captured output to detect errors, exceptions, and warnings.

console_get_resource_usage

Query system resource usage for the host or a specific session.

console_clear_output

Clear output buffers to manage memory and avoid clutter.

console_get_session_state

Retrieve the current state of a session (running, idle, finished).

console_get_command_history

Access the history of commands executed in a session.

console_get_system_metrics

Provide system-wide metrics like CPU, memory, and disk usage.

console_get_session_metrics

Provide metrics scoped to a specific session.

console_get_alerts

Return active monitoring alerts with severities.

console_get_monitoring_dashboard

Provide real-time dashboard data for monitoring.

console_start_monitoring

Begin custom monitoring with configured intervals and thresholds.

console_stop_monitoring

Stop active monitoring sessions.

console_save_profile

Save connection profiles for SSH, Docker, WSL, or cloud platforms.

console_list_profiles

List saved profiles.

console_remove_profile

Remove saved profiles.

console_use_profile

Connect quickly using a saved profile with optional overrides.

console_execute_async

Run commands asynchronously in the background.

console_get_job_status

Check the status of a background job.

console_get_job_output

Retrieve the output from a completed or running job.

console_cancel_job

Cancel a running background job.

console_list_jobs

List all active background jobs.

console_get_job_progress

Monitor progress of a background job.

console_get_job_result

Get the final results and exit code of a completed job.

console_get_job_metrics

Collect statistics on job execution.

console_cleanup_jobs

Clean up completed or failed jobs.

console_assert_output

Assert that session output contains, matches a regex, or equals an expected value.

console_assert_exit_code

Assert the exit code of a command.

console_assert_no_errors

Verify that no errors were detected in the output.

console_save_snapshot

Save a snapshot of session state for later comparison.

console_compare_snapshots

Compare two session state snapshots to identify differences.

console_assert_state

Assert the current session state against expected conditions.