MCPHome

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

MCP server

Install

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

With Julia Pkg (Git) installed:

$ claude mcp add tmux -- /absolute/path/to/project/bin/libtmux-mcp --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

With Julia Pkg (Git) installed:

$ claude mcp add tmux --scope user -- /absolute/path/to/project/bin/libtmux-mcp --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

With Julia Pkg (Git) installed:

$ claude mcp add tmux --scope project -- /absolute/path/to/project/bin/libtmux-mcp --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

With Julia Pkg (Git) installed:

{
    "mcpServers": {
        "tmux": {
            "command": "/absolute/path/to/project/bin/libtmux-mcp",
            "args": ["--socket", "/absolute/path/to/tmux.sock"]
        }
    }
}

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

Config file: claude_desktop_config.json

With Julia Pkg (Git) installed:

$ codex mcp add tmux -- /absolute/path/to/project/bin/libtmux-mcp --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

Config file: ~/.codex/config.toml

With Julia Pkg (Git) installed:

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

[mcp_servers.tmux]
command = "/absolute/path/to/project/bin/libtmux-mcp"
args = ["--socket", "/absolute/path/to/tmux.sock"]

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

With Julia Pkg (Git) installed:

$ gemini mcp add --scope user tmux /absolute/path/to/project/bin/libtmux-mcp -- --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

Config file: ~/.gemini/settings.json

With Julia Pkg (Git) installed:

$ gemini mcp add --scope project tmux /absolute/path/to/project/bin/libtmux-mcp -- --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

With Julia Pkg (Git) installed:

{
    "mcpServers": {
        "tmux": {
            "command": "/absolute/path/to/project/bin/libtmux-mcp",
            "args": ["--socket", "/absolute/path/to/tmux.sock"]
        }
    }
}

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

With Julia Pkg (Git) installed:

{
    "mcpServers": {
        "tmux": {
            "command": "/absolute/path/to/project/bin/libtmux-mcp",
            "args": ["--socket", "/absolute/path/to/tmux.sock"]
        }
    }
}

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

Config file: ~/.cursor/mcp.json

With Julia Pkg (Git) installed:

$ grok mcp add --scope user tmux -- /absolute/path/to/project/bin/libtmux-mcp --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

Config file: ~/.grok/config.toml

With Julia Pkg (Git) installed:

$ grok mcp add --scope project tmux -- /absolute/path/to/project/bin/libtmux-mcp --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

With Julia Pkg (Git) installed:

{
    "mcpServers": {
        "tmux": {
            "command": "/absolute/path/to/project/bin/libtmux-mcp",
            "args": ["--socket", "/absolute/path/to/tmux.sock"]
        }
    }
}

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

With Julia Pkg (Git) installed:

$ opencode mcp add tmux -- /absolute/path/to/project/bin/libtmux-mcp --socket /absolute/path/to/tmux.sock

Run the setup in a consumer project directory. Replace the launcher and socket paths with absolute paths on your machine. The server borrows an existing tmux daemon. Configure tool permissions as described in the MCP server guide.

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

LibTmuxMCP serves a local tmux endpoint over standard input and output. Select an existing server explicitly and configure the tools the client may use. The application leaves the borrowed daemon and existing sessions running when it closes.

The server guide covers package installation, launcher creation, endpoint selection and tool permissions. The API reference documents the Julia embedding surface.

Esc

Type to search.

Reference preview Open reference