You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
why: Configuration was scattered across quickstart and about. Users
looking for env var docs shouldn't wade through installation steps.
what:
- Create docs/configuration.md with env var table
- Include type, default, and description for each variable
- Document socket isolation pattern with example
- Note per-tool socket_name override
Runtime configuration for the libtmux-mcp server. For MCP client setup, see {ref}`clients`.
6
+
7
+
## Environment variables
8
+
9
+
| Variable | Type | Default | Description |
10
+
|----------|------|---------|-------------|
11
+
|`LIBTMUX_SOCKET`| string | (none) | tmux socket name (`-L`). Isolates the MCP server to a specific tmux socket. |
12
+
|`LIBTMUX_SOCKET_PATH`| string | (none) | tmux socket path (`-S`). Alternative to socket name for custom socket locations. |
13
+
|`LIBTMUX_TMUX_BIN`| string |`tmux`| Path to tmux binary. Useful for testing with different tmux versions. |
14
+
|`LIBTMUX_SAFETY`| string |`mutating`| Safety tier: `readonly`, `mutating`, or `destructive`. See {ref}`safety`. |
15
+
16
+
Set environment variables in your MCP client config:
17
+
18
+
```json
19
+
{
20
+
"mcpServers": {
21
+
"libtmux": {
22
+
"command": "uvx",
23
+
"args": ["libtmux-mcp"],
24
+
"env": {
25
+
"LIBTMUX_SOCKET": "ai_workspace",
26
+
"LIBTMUX_SAFETY": "readonly"
27
+
}
28
+
}
29
+
}
30
+
}
31
+
```
32
+
33
+
## Socket isolation
34
+
35
+
By default, the MCP server connects to the default tmux socket. Set `LIBTMUX_SOCKET` to isolate AI agent activity from your personal tmux sessions:
36
+
37
+
```json
38
+
"env": { "LIBTMUX_SOCKET": "ai_workspace" }
39
+
```
40
+
41
+
The agent will only see sessions on the `ai_workspace` socket, not your personal sessions.
42
+
43
+
## All tools accept `socket_name`
44
+
45
+
Every tool accepts an optional `socket_name` parameter that overrides `LIBTMUX_SOCKET` for that call. This allows agents to work across multiple tmux servers in a single session.
0 commit comments