Skip to main content

MCP server for tmux, powered by libtmux

Project description

libtmux-mcp

A Model Context Protocol server for tmux, built on libtmux.

Python Version PyPI Version License

[!WARNING] Pre-alpha. APIs may change. Contributions and feedback welcome.

Give your AI agent hands inside the terminal — create sessions, run commands, read output, orchestrate panes.

Tools

Module Tools
Server list_sessions, create_session, kill_server, get_server_info
Session list_windows, get_session_info, create_window, rename_session, select_window, kill_session
Window list_panes, get_window_info, split_window, rename_window, select_layout, resize_window, move_window, kill_window
Pane send_keys, paste_text, capture_pane, snapshot_pane, search_panes, get_pane_info, wait_for_text, wait_for_content_change, display_message, select_pane, swap_pane, resize_pane, set_pane_title, clear_pane, pipe_pane, enter_copy_mode, exit_copy_mode, respawn_pane, kill_pane
Options show_option, set_option
Environment show_environment, set_environment

Quickstart

Requirements: Python 3.10+, tmux on $PATH.

Install and run:

uvx libtmux-mcp

Claude Code

claude mcp add tmux -- uvx libtmux-mcp

Codex CLI

codex mcp add tmux -- uvx libtmux-mcp

Gemini CLI

gemini mcp add tmux uvx -- libtmux-mcp

Claude Desktop

Add to claude_desktop_config.json:

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

More clients and JSON config: client setup docs

What it feels like

You: Create a session called "api" and run pytest tests/api/ -x in it.

Agent: Created session api with window tests. Running pytest now. Here's the output — 14 passed, 2 failed. The failures are in test_auth.py::test_token_refresh and test_auth.py::test_expired_session. Want me to open those files?

The agent manages tmux directly. No copy-pasting terminal output. No switching windows to check on long-running processes.

When the server earns its keep

For a single tmux send-keys, the server doesn't. It earns its keep the moment the agent has to wait, inspect, or avoid damaging the terminal it is using — pytest finishing, a dev server printing its port, a deploy log settling. The difference then is not more access to tmux, but a better place to put the control loop.

The server-side moves are three:

Waiting. wait_for_text and wait_for_content_change block inside the server until the condition fires. The alternative is the model polling capture-pane in a loop, paying both context tokens and round-trip latency for every turn.

Reading. snapshot_pane returns content, cursor, copy-mode state, and scroll offset as one typed value. The alternative is several tmux invocations stitched together with regex.

Guarding. The server detects the agent's own pane across sockets and declines self-destructive operations — kill_session on itself fails loudly instead of silently terminating the host environment the agent is running in. LIBTMUX_SAFETY (read, read+send, read+send+kill) hides whole tiers from the client's tool list before any prompt is built.

Documentation

Full docs, guides, and tool reference: libtmux-mcp.git-pull.com

Development

Clone and install:

git clone https://github.com/tmux-python/libtmux-mcp.git
cd libtmux-mcp
uv sync --dev

Run the server locally:

uv run libtmux-mcp

Run tests:

uv run pytest

Related projects

License

MIT

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

libtmux_mcp-0.1.0a9.tar.gz (574.3 kB view details)

Uploaded Source

Built Distribution

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

libtmux_mcp-0.1.0a9-py3-none-any.whl (91.6 kB view details)

Uploaded Python 3

File details

Details for the file libtmux_mcp-0.1.0a9.tar.gz.

File metadata

  • Download URL: libtmux_mcp-0.1.0a9.tar.gz
  • Upload date:
  • Size: 574.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for libtmux_mcp-0.1.0a9.tar.gz
Algorithm Hash digest
SHA256 450b7ec85fcaa7e576d694649f64ae52ecada732033f497feee9880c1d18d4f1
MD5 3cddfab45d585b2ef508352910c38de3
BLAKE2b-256 06ea58717eae36222a2b1e935e2464641c09090756f95360631c6fbf7ada53e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for libtmux_mcp-0.1.0a9.tar.gz:

Publisher: tests.yml on tmux-python/libtmux-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 libtmux_mcp-0.1.0a9-py3-none-any.whl.

File metadata

  • Download URL: libtmux_mcp-0.1.0a9-py3-none-any.whl
  • Upload date:
  • Size: 91.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for libtmux_mcp-0.1.0a9-py3-none-any.whl
Algorithm Hash digest
SHA256 8f69ba499fa51fa516f72310206706e9aeca693c5794995a85dec80f0fbd053c
MD5 a0522ba44372dc475fedd1aab898bb59
BLAKE2b-256 a0e39d6100fd4b0d13aafee9d1b725afcf1acad19d7978b25b1039e8eef1b157

See more details on using hashes here.

Provenance

The following attestation bundles were made for libtmux_mcp-0.1.0a9-py3-none-any.whl:

Publisher: tests.yml on tmux-python/libtmux-mcp

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

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