tmux-mcp
A persistent, stateful MCP server that exposes a detached tmux session to clients, enabling shell command execution, terminal buffer reading, and control signal sending via JSON-RPC over stdio.
README
Project BareMetal-Tmux
A decoupled, stateful, interactive MCP (Model Context Protocol) Tmux tool.
It exposes a persistent host tmux session to MCP clients — GitHub Copilot CLI,
ForgeCode, VS Code — over the stdio transport. No containers, no network: raw
JSON-RPC text streams straight into bare-metal shell execution.
Interactive terminal state survives agent crashes, context compaction reloads,
and framework restarts, because the shell lives in a detached tmux session
(local_agent_workspace) owned by the host — not by the agent process.
Architecture
Upstream Client (Copilot CLI / ForgeCode / VS Code)
│ spawns subprocess, speaks JSON-RPC over stdio
▼
Local MCP Server (server.py — Python 3.11+, fastmcp)
│ validates schemas, applies SR-01 safety checks, strips ANSI
▼
Host OS Shell (persistent detached tmux session, 20k-line scrollback)
MCP Tools
| Tool | Arguments | Purpose |
|---|---|---|
execute_command |
command: str, wait_s: float = 0 |
Dispatch a literal shell command into the persistent pane, followed by a carriage return (C-m). Fire-and-forget by default; pass wait_s > 0 (capped at 30) to sleep then return the trailing buffer in the same call. |
read_terminal_buffer |
lines: int = 100 (max 20000) |
Capture trailing scrollback from the pane, with ANSI/OSC/control sequences stripped so payloads always encode cleanly into JSON-RPC. |
send_control_signal |
signal: str = "SIGINT" |
Send SIGINT (Ctrl+C), SIGTSTP, SIGQUIT, or EOF to break blocking processes without killing the harness. |
The session is created lazily on first tool invocation (FR-01) with a 20,000-line history limit.
Safety Guardrails (SR-01)
Execution is un-sandboxed on the host, so the server refuses destructive commands before they reach the tmux buffer:
- Recursive
rmaimed at/or top-level system roots (/usr,/etc, …), includingsudo-wrapped and&&/;-chained variants --no-preserve-root,mkfs.*,dd of=/dev/..., redirects onto block devices, fork-bomb signatures
Workspace-scoped destruction (e.g. rm -rf ./build, /tmp/...) passes through.
Requirements
- Windows host: WSL distro
Ubuntu-24.04withtmuxinstalled (the server runs inside WSL; clients launch it viawsl.exe) - Linux/macOS host: just
tmuxonPATH— drop thewsl.exewrapper and runuv run python server.pydirectly - uv (installed user-locally, e.g.
curl -LsSf https://astral.sh/uv/install.sh | sh) - Python ≥ 3.11 (resolved by uv)
Setup
Dependencies are isolated in a uv-managed venv. On WSL, keep the venv on ext4
(not /mnt/c) for speed:
cd /mnt/c/Users/troll/Python/tmux-harness
export UV_PROJECT_ENVIRONMENT="$HOME/.venvs/tmux-harness"
uv sync
Run the smoke test (28 checks: ANSI stripping, SR-01 guardrails, live tmux round-trips against a throwaway session):
TMUX=harness_smoke_test uv run python tests/smoke_test.py
Client Integration
GitHub Copilot CLI
Two options:
-
Custom agent (recommended) — .github/agents/tmux.agent.md is a self-contained agent profile: it defines the MCP server in its frontmatter and allowlists only the three harness tools (no shell, no file edits, no web). Use it with:
/agent # pick "tmux" interactively copilot --agent=tmux -p "run the test suite and watch for failures" -
Global MCP server — merge mcp-config.copilot.json into
~/.copilot/mcp-config.jsonto expose the harness tools in every session (all built-in tools remain available).
ForgeCode
.mcp.json sits at the project root and is picked up automatically when ForgeCode runs from this directory.
VS Code
Add the same server block from .mcp.json to .vscode/mcp.json.
Configuration
| Variable | Default | Effect |
|---|---|---|
TMUX |
local_agent_workspace |
Name of the persistent tmux session |
UV_PROJECT_ENVIRONMENT |
.venv in project |
Venv location (keep on ext4 under WSL) |
Project Layout
server.py MCP server (tools, SR-01 checks, ANSI stripping)
pyproject.toml uv project: mcp[cli] + fastmcp
tests/smoke_test.py 28-check verification suite
.github/agents/tmux.agent.md Copilot CLI custom agent (harness tools only)
mcp-config.copilot.json Copilot CLI global MCP config
.mcp.json ForgeCode project-root MCP config
Recommended Servers
playwright-mcp
A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.
Magic Component Platform (MCP)
An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.
Audiense Insights MCP Server
Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.
VeyraX MCP
Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.
graphlit-mcp-server
The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.
Kagi MCP Server
An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.
Neon Database
MCP server for interacting with Neon Management API and databases
E2B
Using MCP to run code via e2b.
Exa Search
A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.
Qdrant Server
This repository is an example of how to create a MCP server for Qdrant, a vector search engine.