# Termix MCP server

> Lets an AI agent manage hosts, snippets, dashboard metrics, and audit trails for a self-hosted SSH, RDP, and VNC manager.

- Repository: https://github.com/sujirodev/termix-mcp
- Page: https://hostedmcp.org/servers/sujirodev/termix-mcp
- Transport: stdio
- Stars: 1
- License: MIT
- Latest version: 0.1.0

## Install

### Claude Code

```sh
claude mcp add --env 'TERMIX_API_KEY=<YOUR_TERMIX_API_KEY>' --env 'TERMIX_URL=<TERMIX_URL>' termix-mcp -- uvx termix-mcp
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "termix-mcp": {
      "command": "uvx",
      "args": [
        "termix-mcp"
      ],
      "env": {
        "TERMIX_API_KEY": "<YOUR_TERMIX_API_KEY>",
        "TERMIX_URL": "<TERMIX_URL>"
      }
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "termix-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "termix-mcp"
      ],
      "env": {
        "TERMIX_API_KEY": "<YOUR_TERMIX_API_KEY>",
        "TERMIX_URL": "<TERMIX_URL>"
      }
    }
  }
}
```

### VS Code CLI

```sh
code --add-mcp '{"name":"termix-mcp","type":"stdio","command":"uvx","args":["termix-mcp"],"env":{"TERMIX_API_KEY":"<YOUR_TERMIX_API_KEY>","TERMIX_URL":"<TERMIX_URL>"}}'
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "termix-mcp": {
      "command": "uvx",
      "args": [
        "termix-mcp"
      ],
      "env": {
        "TERMIX_API_KEY": "<YOUR_TERMIX_API_KEY>",
        "TERMIX_URL": "<TERMIX_URL>"
      }
    }
  }
}
```

### Codex

```sh
codex mcp add termix-mcp --env 'TERMIX_API_KEY=<YOUR_TERMIX_API_KEY>' --env 'TERMIX_API_KEY=<YOUR_TERMIX_API_KEY>' --env 'TERMIX_URL=<TERMIX_URL>' --env 'TERMIX_URL=<TERMIX_URL>' -- uvx termix-mcp
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.termix-mcp]
command = "uvx"
args = ["termix-mcp"]

[mcp_servers.termix-mcp.env]
TERMIX_API_KEY = "<YOUR_TERMIX_API_KEY>"
TERMIX_URL = "<TERMIX_URL>"
```

### Gemini CLI

```sh
gemini mcp add -s user -e 'TERMIX_API_KEY=<YOUR_TERMIX_API_KEY>' -e 'TERMIX_API_KEY=<YOUR_TERMIX_API_KEY>' -e 'TERMIX_URL=<TERMIX_URL>' -e 'TERMIX_URL=<TERMIX_URL>' termix-mcp uvx -- termix-mcp
```

### Gemini settings.json (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "termix-mcp": {
      "command": "uvx",
      "args": [
        "termix-mcp"
      ],
      "env": {
        "TERMIX_API_KEY": "<YOUR_TERMIX_API_KEY>",
        "TERMIX_URL": "<TERMIX_URL>"
      }
    }
  }
}
```

## Environment variables

| Name | Required | Secret | Description |
|---|---|---|---|
| `TERMIX_API_KEY` | yes | yes | Termix API key (tmx_...) |
| `TERMIX_API_KEY` | yes | yes | Termix API key (tmx_...) |
| `TERMIX_URL` | yes | no | Base URL of the Termix instance |
| `TERMIX_URL` | yes | no | Base URL of the Termix instance |
| `TERMIX_MCP_READ_ONLY` | no | no | Hide and block every write tool |
| `TERMIX_MCP_TOOLSETS` | no | no | default, all, or a comma-separated list (hosts,snippets,files,...) |

## Tools (78)

- `termix_get_audit_forwarding`
- `termix_get_branding`
- `termix_get_encryption_status`
- `termix_get_host_defaults`
- `termix_get_termix_id_status`
- `termix_list_sso_providers`
- `termix_update_branding`
- `termix_acknowledge_alert_firing`
- `termix_create_alert_rule`
- `termix_delete_alert_rule`
- `termix_list_alert_rules`
- `termix_get_session_log`
- `termix_list_audit_events`
- `termix_list_session_logs`
- `termix_get_automation`
- `termix_list_automations`
- `termix_list_fleets`
- `termix_run_automation`
- `termix_create_credential`
- `termix_delete_credential`
- `termix_get_credential`
- `termix_list_credentials`
- `termix_reveal_credential`
- `termix_update_credential`
- `termix_get_dashboard_summary`
- `termix_get_homepage`
- `termix_list_open_tabs`
- `termix_list_workspaces`
- `termix_get_container`
- `termix_get_container_logs`
- `termix_get_container_stats`
- `termix_list_containers`
- `termix_restart_container`
- `termix_start_container`
- `termix_stop_container`
- `termix_create_folder`
- `termix_delete_file`
- `termix_list_files`
- `termix_move_file`
- `termix_read_file`
- `termix_rename_file`
- `termix_write_file`
- `termix_create_host`
- `termix_delete_host`
- `termix_disable_host_autostart`
- `termix_enable_host_autostart`
- `termix_get_host`
- `termix_get_network_topology`
- `termix_list_host_folders`
- `termix_list_host_tags`
- `termix_list_hosts`
- `termix_update_host`
- `termix_get_host_metrics`
- `termix_get_host_status`
- `termix_get_metrics_history`
- `termix_get_proxmox_stats`
- `termix_list_active_alerts`
- `termix_list_host_statuses`
- `termix_create_snippet`
- `termix_delete_snippet`
- `termix_get_snippet`
- `termix_list_snippets`
- `termix_run_snippet`
- `termix_update_snippet`
- `termix_get_preferences`
- `termix_get_system_info`
- `termix_list_api_keys`
- `termix_create_tunnel`
- `termix_delete_tunnel`
- `termix_get_tunnel`
- `termix_list_tunnel_presets`
- `termix_list_tunnels`
- `termix_assign_role`
- `termix_get_user`
- `termix_list_credential_access`
- `termix_list_folder_access`
- `termix_list_roles`
- `termix_list_users`

## FAQ

### What does the Termix MCP server allow an agent to do?

It allows an agent to list and operate Termix hosts, snippets, dashboard, metrics, and audit trails.

### How do I install the Termix MCP server?

You can install it using `uvx termix-mcp`, via `pip install termix-mcp`, or by using the Docker image `ghcr.io/sujirodev/termix-mcp`.

### Is there a read-only mode available?

Yes, setting the TERMIX_MCP_READ_ONLY environment variable to true will hide and block all tools that are not read-only.

### What authentication is required?

The server requires a Termix API key (starting with `tmx_`) and the Termix base URL.
