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
docs(configuration): Make env variables linkable via labels
why: LIBTMUX_SAFETY and other env vars should be cross-referenceable
from anywhere in the docs, following the pattern used by libtmux.
what:
- Restructure configuration.md: one heading per env var with MyST labels
(LIBTMUX_SOCKET)=, (LIBTMUX_SOCKET_PATH)=, etc.
- {ref}`LIBTMUX_SAFETY` now links to configuration/#libtmux-safety
- Update safety page and glossary to use {ref} links
Copy file name to clipboardExpand all lines: docs/configuration.md
+40-8Lines changed: 40 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,44 @@ Runtime configuration for the libtmux-mcp server. For MCP client setup, see {ref
6
6
7
7
## Environment variables
8
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`. |
9
+
(LIBTMUX_SOCKET)=
10
+
11
+
### `LIBTMUX_SOCKET`
12
+
13
+
tmux socket name (`-L`). Isolates the MCP server to a specific tmux socket.
14
+
15
+
-**Type:** string
16
+
-**Default:** (none — uses the default tmux socket)
17
+
18
+
(LIBTMUX_SOCKET_PATH)=
19
+
20
+
### `LIBTMUX_SOCKET_PATH`
21
+
22
+
tmux socket path (`-S`). Alternative to socket name for custom socket locations.
23
+
24
+
-**Type:** string
25
+
-**Default:** (none)
26
+
27
+
(LIBTMUX_TMUX_BIN)=
28
+
29
+
### `LIBTMUX_TMUX_BIN`
30
+
31
+
Path to tmux binary. Useful for testing with different tmux versions.
32
+
33
+
-**Type:** string
34
+
-**Default:**`tmux`
35
+
36
+
(LIBTMUX_SAFETY)=
37
+
38
+
### `LIBTMUX_SAFETY`
39
+
40
+
Safety tier controlling which tools are available. See {ref}`safety`.
41
+
42
+
-**Type:** string
43
+
-**Default:**`mutating`
44
+
-**Values:**`readonly`, `mutating`, `destructive`
45
+
46
+
## Setting environment variables
15
47
16
48
Set environment variables in your MCP client config:
17
49
@@ -32,7 +64,7 @@ Set environment variables in your MCP client config:
32
64
33
65
## Socket isolation
34
66
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:
67
+
By default, the MCP server connects to the default tmux socket. Set {ref}`LIBTMUX_SOCKET` to isolate AI agent activity from your personal tmux sessions:
36
68
37
69
```json
38
70
"env": { "LIBTMUX_SOCKET": "ai_workspace" }
@@ -42,4 +74,4 @@ The agent will only see sessions on the `ai_workspace` socket, not your personal
42
74
43
75
## All tools accept `socket_name`
44
76
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.
77
+
Every tool accepts an optional `socket_name` parameter that overrides {ref}`LIBTMUX_SOCKET` for that call. This allows agents to work across multiple tmux servers in a single session.
0 commit comments