MCPconceptHome

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Edit this page on GitHub

tmux MCP for Rust

Install

Choose your client and configuration scope, then run the command or paste the configuration.

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ claude mcp add tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.claude.json (this project)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ claude mcp add tmux --scope user -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.claude.json (all projects)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ claude mcp add tmux --scope project -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: .mcp.json (in repo, version-controlled)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then use this config:

{
    "mcpServers": {
        "tmux": {
            "command": "tmux-mcp"
        }
    }
}

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: claude_desktop_config.json

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ codex mcp add tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.codex/config.toml

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

Codex's CLI doesn't support project scope yet — paste this into .codex/config.toml at the repo root.

[mcp_servers.tmux]
command = "tmux-mcp"

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: .codex/config.toml (in repo)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ gemini mcp add --scope user tmux tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.gemini/settings.json

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ gemini mcp add --scope project tmux tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: .gemini/settings.json (in repo)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then use this config:

{
    "mcpServers": {
        "tmux": {
            "command": "tmux-mcp"
        }
    }
}

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: .cursor/mcp.json (in repo)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then use this config:

{
    "mcpServers": {
        "tmux": {
            "command": "tmux-mcp"
        }
    }
}

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.cursor/mcp.json

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ grok mcp add --scope user tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.grok/config.toml

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ grok mcp add --scope project tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ./.grok/config.toml (in repo)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then use this config:

{
    "mcpServers": {
        "tmux": {
            "command": "tmux-mcp"
        }
    }
}

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.gemini/config/mcp_config.json

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ opencode mcp add tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.config/opencode/opencode.jsonc

tmux-mcp serves tmux over MCP stdio. It provides topology discovery, terminal capture, command execution, bounded waits, and a static capability resource.

Building requires Rust 1.88 or newer. Running requires tmux 3.3a or newer. Toolsets select inspection, management, execution, and teardown. Read tmux://capabilities for the effective startup selection.

Start here

  • Install points an MCP client at this server.
  • Tools lists the MCP operations, arguments, and results.
  • Guides connect a client and choose its tmux socket.
  • Topics explain toolsets, command waits, and capability discovery.
  • Examples run a Rust MCP client with a private tmux server.
  • Language API documents embedding and implementation types.

The Rust Workspace Manager is a separate crate. The current MCP catalog does not include a workspace-file operation.

Crate documentation and prerequisites.

Esc

Type to search.

Reference preview Open reference