Skip to content

Repository files navigation

cmuxLayer

Your AI agents can't see each other's terminals. One runs in tab 1, another in tab 2 — and you're the clipboard between them. cmuxLayer fixes that: 35 MCP tools that give AI agents programmatic control over terminal workspaces.

cmuxLayer

install License MCP Tools Tests

Quick Start

brew install etanhey/layers/cmuxlayer       # stable, pinned release
brew install --HEAD etanhey/layers/cmuxlayer # or: dogfood the latest main

This installs the cmuxlayer command (plus cmuxlayer-app-server / cmuxlayer-proxy). Requires cmux to be running. For how the golem fleet wires, versions, and dogfoods it — and the CMUX_SOCKET_PATH instance pin — see docs/releases-and-brew.md.

Then set up this machine:

cmuxlayer init

The wizard asks which repositories agents may be spawned in, whether cmuxlayer should call per-repo shell launcher functions or the agent CLIs directly, and whether agents run unattended or stop to ask for tool approval. It writes the config those answers produce (~/.config/cmuxlayer/env.sh, plus a launcher registry in launcher mode), which cmuxlayer reads at startup — so a GUI-launched MCP client gets the same configuration as a terminal one, without sourcing anything. It never rewrites an existing file without asking, and backs one up before it does. --yes with --repo <name>=<path> does the same non-interactively for scripted installs. Nothing else in cmuxlayer assumes a particular directory layout — see docs/fresh-install.md for the walkthrough and docs/registry-optional-spawn.md for how each lane behaves.

Optional fleet sidebar

The lane-grouped fleet view is opt-in. Install its fallback file with:

bun run install:fleet-sidebar

cmuxLayer then refreshes ~/.config/cmux/sidebars/fleet.swift from its reconciled live-agent snapshot. It does not change cmux settings or replace the stock sidebar. To activate it, right-click the sidebar toggle and choose fleet; choose the stock entry there whenever you want the fallback UI.

Development and screenshot QA use a separate picker entry and never publish to the live fleet.swift path:

bun run install:fleet-sidebar:dev
bun run dev

Those commands publish only ~/.config/cmux/sidebars/fleet-dev.swift; choose fleet-dev in cmux while testing. Runtime tests must inject a temporary publisher outputPath.

Add to your MCP config:

Codex CLI / T3 Code

T3 Code inherits MCP servers from the Codex CLI config file at ~/.codex/config.toml (or $CODEX_HOME/config.toml).

[mcp_servers.cmuxlayer]
command = "cmuxlayer"

Claude Code, Cursor, VS Code, Claude Desktop

{
  "mcpServers": {
    "cmuxlayer": {
      "command": "cmuxlayer"
    }
  }
}

To keep only a per-session resident subset of tools, set CMUXLAYER_DEFAULT_PALETTE to comma-separated bare tool names, for example list_surfaces,spawn_agent,send_to. The server also exposes expand_palette, which makes every deferred tool available for the rest of that MCP session. When unset or blank, the signed 12-tool thin-core default applies. When set, the environment value overrides that default for the session. Unknown names are warned and ignored while valid names still load.

Autonomous prompt resolution is experimental and disabled by default. With the default policy, cmuxlayer still detects prompt choosers, marks the agent blocked_on_prompt, and escalates without sending any key. Setting CMUXLAYER_EXPERIMENTAL_PROMPT_AUTO_RESOLVE=1 restores the known-imperfect Escape-based resolver for isolated testing only; do not enable it for fleet use.

Config locations: Codex CLI / T3 Code ~/.codex/config.toml (or $CODEX_HOME/config.toml) | Claude Code .mcp.json or claude mcp add cmuxlayer -s user -- cmuxlayer | Cursor .cursor/mcp.json | VS Code .vscode/mcp.json | Claude Desktop — see MCP docs for platform-specific paths

What You Can Do

Tell your AI agent things like:

  • "Split a pane to the right and run my test suite there"
  • "Spawn a Claude Code agent in a new pane to refactor auth.ts"
  • "Read the screen of surface:2 and tell me if the build passed"
  • "Wait for all agents to finish, then read their output"
  • "Set the sidebar status to show our deploy progress"

Under the hood, cmuxLayer keeps 42 MCP tools callable for terminal control, screen reading, layout management, and multi-agent orchestration. The default palette is intentionally limited to 12; the remaining tools are loaded through ToolSearch. reorder_surface is the single approved deletion. read_screen parses agent metadata (status, model, tokens, context %) for Claude Code, Codex, Gemini, and Cursor.

Agent Routing Workflow

For managed agents, use the agent-first path: list_agents to find the target, send_to to deliver work by agent_id, then wait_for when you need completion. send_to also preserves the registry-independent escape hatch: use mode:"surface", mode:"command", or mode:"key" with a raw surface ref for shells, launch/resume commands, and stuck-pane recovery.

See Agent Routing and Handling Workflow for the full operator playbook, including stuck surface recovery and safe /mcp menu reconnects.

MCP Tools (42 registered, 12 default)

All tools ship with ToolAnnotations for automatic safety policy enforcement.

Default palettespawn_agent send_to wait_for read_screen my_agents list_agents broadcast close_surface dispatch_to_agent list_surfaces control_health stop_agent

The other 30 definitions, including interact, are interim ToolSearch-deferred and remain callable. This metadata split is deliberately reversible while the project decides which low-frequency operations belong in MCP versus CLI/programmatic surfaces.

Terminal controllist_surfaces control_health select_workspace create_workspace delete_workspace new_split new_surface move_surface send_input send_command send_key read_screen rename_tab close_surface browser_surface

Agent lifecyclespawn_agent new_worktree_split spawn_in_workspace send_to send_to_agent wait_for wait_for_all interact stop_agent kill supersede_agent_goal broadcast

Metacomm (agent inbox)dispatch_to_agent inbox_check

Workspace statelist_agents my_agents get_agent_state read_agent_output notify set_status set_progress

Monitor registryregister_monitor signal_monitor deregister_monitor list_monitors query_monitor_registry

Full tool reference

Read-only (10)

Tool What it does
list_surfaces List all surfaces across workspaces
control_health Report socket, binary, process, and job-control diagnostics
read_screen Read terminal output with parsed agent status
get_agent_state Full state of a tracked agent
list_agents All agents, with optional filters
my_agents Children of a parent agent with live screen status
read_agent_output Structured output between delimiter markers
inbox_check Inspect an agent's inbox channel: pending messages, monitor liveness, stale dispatches
list_monitors List shared monitor-registry records
query_monitor_registry Query monitor gates and liveness metadata

Mutating (29)

Tool What it does
select_workspace Switch the active workspace
create_workspace Create a new named workspace
delete_workspace Delete a workspace after live-agent and caller-workspace safety checks
new_split Deprecated one-release alias; use spawn_agent(placement:...) for managed agents
new_surface Create a tab in an existing pane
move_surface Move a surface to another pane or position
send_input Deprecated one-release alias for send_to(mode:"surface")
send_command Deprecated one-release alias for send_to(mode:"command")
send_key Deprecated one-release alias for send_to(mode:"key")
rename_tab Rename a surface tab
notify Show a cmux notification banner
set_status Set sidebar status key-value pair
set_progress Set progress indicator (0.0-1.0)
browser_surface Interact with browser surfaces
spawn_agent Spawn a CLI agent and return an agent_id for routing
new_worktree_split Deprecated one-release alias; use spawn_agent(worktree:true, placement:"worker")
spawn_in_workspace Deprecated one-release alias; create/reuse a workspace and call spawn_agent for each managed agent
dispatch_to_agent Append a task to an agent's inbox file (deterministic write channel)
send_to Send by agent ID or raw surface using `mode:"agent"
send_to_agent Deprecated one-release alias for send_to(mode:"agent")
wait_for Wait for one agent_id or several ids (defaults to done)
wait_for_all Deprecated one-release alias for wait_for(ids:[...])
interact Send interactive input (confirm, cancel, resume)
broadcast Fan out a guarded message to agents by role
supersede_agent_goal Replace a managed agent's active file-backed goal
register_monitor Register or re-arm a monitor deadman record
signal_monitor Refresh a monitor heartbeat
deregister_monitor Mark a monitor intentionally stopped

Destructive (3)

Tool What it does
close_surface Close a terminal or browser pane
stop_agent Gracefully stop an agent
kill Force-kill agent processes

Supported Agents

CLI Command Auto-detected
Claude Code claude status, model, tokens, context %
Codex codex status, model, context %
Gemini CLI gemini status, model, tokens, context %
Cursor cursor agent status, model, tokens, context %
read_screen auto-detects agent type and parses metadata from terminal output.

Architecture

AI Agent  ─── MCP ───>  cmuxLayer  ─── Unix socket ───>  cmux
                         ├── Agent engine (spawn → monitor → teardown)
                         ├── Screen parser (5 agent formats)
                         ├── Mode policy (autonomous vs manual)
                         ├── State manager + event log
                         ├── Metacomm READ  — harness JSONL (real tokens/context/model)
                         └── Metacomm WRITE — per-agent inbox file + Monitor dispatch

The socket client connects to cmux via Unix socket. Auto-reconnects on disconnect, falls back to CLI subprocess if socket is unavailable.

Connection Latency Speedup
CLI subprocess ~142ms baseline
Unix socket ~0.1ms 1,423x

Troubleshooting

cmux is not running cmuxLayer requires a running cmux instance. Install it first, then start a cmux session before using cmuxLayer.

Tools not appearing in Codex CLI or T3 Code Restart the client after adding cmuxlayer to ~/.codex/config.toml. If you use a custom Codex home, verify $CODEX_HOME/config.toml contains the same mcp_servers.cmuxlayer entry.

Tools not appearing in Claude Code Restart Claude Code after adding the MCP config. Run claude mcp list to verify cmuxlayer is connected.

Socket connection failed cmuxLayer auto-discovers the cmux socket (macOS: ~/Library/Application Support/cmux/cmux.sock). Override with CMUX_SOCKET_PATH if needed.

"Cannot resolve a working directory for repo ..." cmuxLayer could not find that checkout. Run cmuxlayer init to register it, or set CMUXLAYER_REPO_HOME to the colon-separated directories holding your repositories. The error lists every path it searched.

Testing

bun run test        # 3023 tests via vitest
npm run typecheck   # Type checking

Git hooks

Enable project hooks to run the regression gate automatically on git push:

git config core.hooksPath .githooks

This enables .githooks/pre-push, which runs scripts/run_tests.sh and blocks pushes on regression failures.

Development

npm install
npm run dev         # Run with tsx (hot reload)
npm run build       # Compile TypeScript
npm start           # Run compiled output

Contributing

See CONTRIBUTING.md for development setup and PR guidelines.

License

Apache 2.0 — see LICENSE.


Part of the Golems AI agent ecosystem. cmuxlayer.etanheyman.com | Built by @EtanHey.

About

cmux MCP server — 42 tools for terminal agent lifecycle management. Spawn, monitor, and orchestrate Claude, Codex, Cursor, Gemini, Kiro agents. Thinking-state detection, chunked input, layout management.

Topics

Resources

Contributing

Stars

24 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages