Skip to content

Commit 570a3fa

Browse files
committed
docs(clients): Add inline tabs for uvx / pipx / pip install variants
why: Users install via different methods. Each client section should show the matching config for uvx, pipx, or a direct pip install. what: - Add sphinx-inline-tabs to all 5 client sections (Claude Code, Claude Desktop, Codex CLI, Gemini CLI, Cursor) - Each section has 3 tabs: uvx, pipx, pip install - All CLI commands verified working (add + remove tested per client) - All JSON configs validated
1 parent 35b4f7d commit 570a3fa

1 file changed

Lines changed: 98 additions & 5 deletions

File tree

docs/clients.md

Lines changed: 98 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,87 @@ Copy-pasteable configuration for every supported MCP client. If your client isn'
66

77
## Claude Code
88

9+
`````{tab} uvx
910
```console
1011
$ claude mcp add libtmux -- uvx libtmux-mcp
1112
```
13+
`````
14+
15+
`````{tab} pipx
16+
```console
17+
$ claude mcp add libtmux -- pipx run libtmux-mcp
18+
```
19+
`````
20+
21+
`````{tab} pip install
22+
```console
23+
$ claude mcp add libtmux -- libtmux-mcp
24+
```
25+
`````
1226

1327
Config file: `.mcp.json` (project) or `~/.claude.json` (global).
1428

1529
## Claude Desktop
1630

1731
Add to `claude_desktop_config.json`:
1832

33+
`````{tab} uvx
1934
```json
2035
{
2136
"mcpServers": {
2237
"libtmux": {
2338
"command": "uvx",
24-
"args": ["libtmux-mcp"],
25-
"env": {
26-
"LIBTMUX_SOCKET": "ai_workspace"
27-
}
39+
"args": ["libtmux-mcp"]
40+
}
41+
}
42+
}
43+
```
44+
`````
45+
46+
`````{tab} pipx
47+
```json
48+
{
49+
"mcpServers": {
50+
"libtmux": {
51+
"command": "pipx",
52+
"args": ["run", "libtmux-mcp"]
53+
}
54+
}
55+
}
56+
```
57+
`````
58+
59+
`````{tab} pip install
60+
```json
61+
{
62+
"mcpServers": {
63+
"libtmux": {
64+
"command": "libtmux-mcp"
2865
}
2966
}
3067
}
3168
```
69+
`````
3270

3371
## Codex CLI
3472

73+
`````{tab} uvx
3574
```console
3675
$ codex mcp add libtmux -- uvx libtmux-mcp
3776
```
77+
`````
78+
79+
`````{tab} pipx
80+
```console
81+
$ codex mcp add libtmux -- pipx run libtmux-mcp
82+
```
83+
`````
84+
85+
`````{tab} pip install
86+
```console
87+
$ codex mcp add libtmux -- libtmux-mcp
88+
```
89+
`````
3890

3991
<details>
4092
<summary>config.toml format</summary>
@@ -51,16 +103,31 @@ args = ["libtmux-mcp"]
51103

52104
## Gemini CLI
53105

106+
`````{tab} uvx
54107
```console
55108
$ gemini mcp add libtmux uvx -- libtmux-mcp
56109
```
110+
`````
111+
112+
`````{tab} pipx
113+
```console
114+
$ gemini mcp add libtmux pipx -- run libtmux-mcp
115+
```
116+
`````
117+
118+
`````{tab} pip install
119+
```console
120+
$ gemini mcp add libtmux libtmux-mcp
121+
```
122+
`````
57123

58124
Config file: `~/.gemini/settings.json` (JSON format, same schema as Claude Desktop).
59125

60126
## Cursor
61127

62128
Add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
63129

130+
`````{tab} uvx
64131
```json
65132
{
66133
"mcpServers": {
@@ -71,6 +138,32 @@ Add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
71138
}
72139
}
73140
```
141+
`````
142+
143+
`````{tab} pipx
144+
```json
145+
{
146+
"mcpServers": {
147+
"libtmux": {
148+
"command": "pipx",
149+
"args": ["run", "libtmux-mcp"]
150+
}
151+
}
152+
}
153+
```
154+
`````
155+
156+
`````{tab} pip install
157+
```json
158+
{
159+
"mcpServers": {
160+
"libtmux": {
161+
"command": "libtmux-mcp"
162+
}
163+
}
164+
}
165+
```
166+
`````
74167

75168
## MCP Inspector
76169

@@ -146,5 +239,5 @@ $ gemini mcp add \
146239
## Common pitfalls
147240

148241
- **Absolute paths**: Some clients require absolute paths in config. Use `$HOME/...` or the full path instead of `~/...`.
149-
- **Virtual environments**: If using pip install (not uvx), ensure the venv is activated or use `uv run`.
242+
- **Virtual environments**: If using pip install, ensure the venv is activated or the `libtmux-mcp` binary is on your PATH.
150243
- **Socket isolation**: Set `LIBTMUX_SOCKET` in the `env` block to isolate the MCP server from your default tmux. See {ref}`configuration`.

0 commit comments

Comments
 (0)