Skip to content

Commit 837face

Browse files
tonytony
committed
docs(quickstart,clients): nested client/install-method tabs with tool hints
Quickstart now picks the MCP client (Claude Code / Claude Desktop / Codex / Gemini / Cursor) up front, then nests install-method tabs (uvx / pipx / pip install) inside — so every client gets a copy-pasteable first command without bouncing to clients.md. uvx and pipx tabs lead with "With [uv]/[pipx] installed:" and link to the respective tool docs; pip install tabs show the `pip install --user --upgrade libtmux libtmux-mcp` prereq before the per-client registration step. clients.md mirrors the same structure so the two pages don't drift.
1 parent ef13e46 commit 837face

2 files changed

Lines changed: 269 additions & 1 deletion

File tree

‎docs/clients.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,30 @@ Copy-pasteable configuration for every supported MCP client. If your client isn'
77
## Claude Code
88

99
`````{tab} uvx
10+
With [uv](https://docs.astral.sh/uv/) installed:
11+
1012
```console
1113
$ claude mcp add libtmux -- uvx libtmux-mcp
1214
```
1315
`````
1416

1517
`````{tab} pipx
18+
With [pipx](https://pipx.pypa.io/) installed:
19+
1620
```console
1721
$ claude mcp add libtmux -- pipx run libtmux-mcp
1822
```
1923
`````
2024

2125
`````{tab} pip install
26+
Install the packages first:
27+
28+
```console
29+
$ pip install --user --upgrade libtmux libtmux-mcp
30+
```
31+
32+
Then register:
33+
2234
```console
2335
$ claude mcp add libtmux -- libtmux-mcp
2436
```
@@ -31,6 +43,8 @@ Config file: `.mcp.json` (project) or `~/.claude.json` (global).
3143
Add to `claude_desktop_config.json`:
3244

3345
`````{tab} uvx
46+
With [uv](https://docs.astral.sh/uv/) installed:
47+
3448
```json
3549
{
3650
"mcpServers": {
@@ -44,6 +58,8 @@ Add to `claude_desktop_config.json`:
4458
`````
4559

4660
`````{tab} pipx
61+
With [pipx](https://pipx.pypa.io/) installed:
62+
4763
```json
4864
{
4965
"mcpServers": {
@@ -57,6 +73,14 @@ Add to `claude_desktop_config.json`:
5773
`````
5874

5975
`````{tab} pip install
76+
Install the packages first:
77+
78+
```console
79+
$ pip install --user --upgrade libtmux libtmux-mcp
80+
```
81+
82+
Then use this config:
83+
6084
```json
6185
{
6286
"mcpServers": {
@@ -71,18 +95,30 @@ Add to `claude_desktop_config.json`:
7195
## Codex CLI
7296

7397
`````{tab} uvx
98+
With [uv](https://docs.astral.sh/uv/) installed:
99+
74100
```console
75101
$ codex mcp add libtmux -- uvx libtmux-mcp
76102
```
77103
`````
78104

79105
`````{tab} pipx
106+
With [pipx](https://pipx.pypa.io/) installed:
107+
80108
```console
81109
$ codex mcp add libtmux -- pipx run libtmux-mcp
82110
```
83111
`````
84112

85113
`````{tab} pip install
114+
Install the packages first:
115+
116+
```console
117+
$ pip install --user --upgrade libtmux libtmux-mcp
118+
```
119+
120+
Then register:
121+
86122
```console
87123
$ codex mcp add libtmux -- libtmux-mcp
88124
```
@@ -104,18 +140,30 @@ args = ["libtmux-mcp"]
104140
## Gemini CLI
105141

106142
`````{tab} uvx
143+
With [uv](https://docs.astral.sh/uv/) installed:
144+
107145
```console
108146
$ gemini mcp add libtmux uvx -- libtmux-mcp
109147
```
110148
`````
111149

112150
`````{tab} pipx
151+
With [pipx](https://pipx.pypa.io/) installed:
152+
113153
```console
114154
$ gemini mcp add libtmux pipx -- run libtmux-mcp
115155
```
116156
`````
117157

118158
`````{tab} pip install
159+
Install the packages first:
160+
161+
```console
162+
$ pip install --user --upgrade libtmux libtmux-mcp
163+
```
164+
165+
Then register:
166+
119167
```console
120168
$ gemini mcp add libtmux libtmux-mcp
121169
```
@@ -128,6 +176,8 @@ Config file: `~/.gemini/settings.json` (JSON format, same schema as Claude Deskt
128176
Add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
129177

130178
`````{tab} uvx
179+
With [uv](https://docs.astral.sh/uv/) installed:
180+
131181
```json
132182
{
133183
"mcpServers": {
@@ -141,6 +191,8 @@ Add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
141191
`````
142192

143193
`````{tab} pipx
194+
With [pipx](https://pipx.pypa.io/) installed:
195+
144196
```json
145197
{
146198
"mcpServers": {
@@ -154,6 +206,14 @@ Add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
154206
`````
155207

156208
`````{tab} pip install
209+
Install the packages first:
210+
211+
```console
212+
$ pip install --user --upgrade libtmux libtmux-mcp
213+
```
214+
215+
Then use this config:
216+
157217
```json
158218
{
159219
"mcpServers": {

‎docs/quickstart.md‎

Lines changed: 209 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,219 @@ One happy path from zero to a working tool invocation.
66

77
## 1. Install
88

9+
Pick your MCP client and install method:
10+
11+
`````````{tab} Claude Code
12+
`````{tab} uvx
13+
With [uv](https://docs.astral.sh/uv/) installed:
14+
915
```console
1016
$ claude mcp add libtmux -- uvx libtmux-mcp
1117
```
18+
`````
19+
20+
`````{tab} pipx
21+
With [pipx](https://pipx.pypa.io/) installed:
22+
23+
```console
24+
$ claude mcp add libtmux -- pipx run libtmux-mcp
25+
```
26+
`````
27+
28+
`````{tab} pip install
29+
Install the packages first:
30+
31+
```console
32+
$ pip install --user --upgrade libtmux libtmux-mcp
33+
```
34+
35+
Then register:
36+
37+
```console
38+
$ claude mcp add libtmux -- libtmux-mcp
39+
```
40+
`````
41+
42+
Config file: `.mcp.json` (project) or `~/.claude.json` (global).
43+
`````````
44+
45+
`````````{tab} Claude Desktop
46+
Add to `claude_desktop_config.json`:
47+
48+
`````{tab} uvx
49+
With [uv](https://docs.astral.sh/uv/) installed:
50+
51+
```json
52+
{
53+
"mcpServers": {
54+
"libtmux": {
55+
"command": "uvx",
56+
"args": ["libtmux-mcp"]
57+
}
58+
}
59+
}
60+
```
61+
`````
62+
63+
`````{tab} pipx
64+
With [pipx](https://pipx.pypa.io/) installed:
65+
66+
```json
67+
{
68+
"mcpServers": {
69+
"libtmux": {
70+
"command": "pipx",
71+
"args": ["run", "libtmux-mcp"]
72+
}
73+
}
74+
}
75+
```
76+
`````
77+
78+
`````{tab} pip install
79+
Install the packages first:
80+
81+
```console
82+
$ pip install --user --upgrade libtmux libtmux-mcp
83+
```
84+
85+
Then use this config:
86+
87+
```json
88+
{
89+
"mcpServers": {
90+
"libtmux": {
91+
"command": "libtmux-mcp"
92+
}
93+
}
94+
}
95+
```
96+
`````
97+
`````````
98+
99+
`````````{tab} Codex CLI
100+
`````{tab} uvx
101+
With [uv](https://docs.astral.sh/uv/) installed:
102+
103+
```console
104+
$ codex mcp add libtmux -- uvx libtmux-mcp
105+
```
106+
`````
107+
108+
`````{tab} pipx
109+
With [pipx](https://pipx.pypa.io/) installed:
110+
111+
```console
112+
$ codex mcp add libtmux -- pipx run libtmux-mcp
113+
```
114+
`````
115+
116+
`````{tab} pip install
117+
Install the packages first:
118+
119+
```console
120+
$ pip install --user --upgrade libtmux libtmux-mcp
121+
```
122+
123+
Then register:
124+
125+
```console
126+
$ codex mcp add libtmux -- libtmux-mcp
127+
```
128+
`````
129+
130+
Config file: `~/.codex/config.toml` (TOML format — see {ref}`clients` for the schema).
131+
`````````
132+
133+
`````````{tab} Gemini CLI
134+
`````{tab} uvx
135+
With [uv](https://docs.astral.sh/uv/) installed:
136+
137+
```console
138+
$ gemini mcp add libtmux uvx -- libtmux-mcp
139+
```
140+
`````
141+
142+
`````{tab} pipx
143+
With [pipx](https://pipx.pypa.io/) installed:
144+
145+
```console
146+
$ gemini mcp add libtmux pipx -- run libtmux-mcp
147+
```
148+
`````
149+
150+
`````{tab} pip install
151+
Install the packages first:
152+
153+
```console
154+
$ pip install --user --upgrade libtmux libtmux-mcp
155+
```
156+
157+
Then register:
158+
159+
```console
160+
$ gemini mcp add libtmux libtmux-mcp
161+
```
162+
`````
163+
164+
Config file: `~/.gemini/settings.json` (same JSON schema as Claude Desktop).
165+
`````````
166+
167+
`````````{tab} Cursor
168+
Add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
169+
170+
`````{tab} uvx
171+
With [uv](https://docs.astral.sh/uv/) installed:
172+
173+
```json
174+
{
175+
"mcpServers": {
176+
"libtmux": {
177+
"command": "uvx",
178+
"args": ["libtmux-mcp"]
179+
}
180+
}
181+
}
182+
```
183+
`````
184+
185+
`````{tab} pipx
186+
With [pipx](https://pipx.pypa.io/) installed:
187+
188+
```json
189+
{
190+
"mcpServers": {
191+
"libtmux": {
192+
"command": "pipx",
193+
"args": ["run", "libtmux-mcp"]
194+
}
195+
}
196+
}
197+
```
198+
`````
199+
200+
`````{tab} pip install
201+
Install the packages first:
202+
203+
```console
204+
$ pip install --user --upgrade libtmux libtmux-mcp
205+
```
206+
207+
Then use this config:
208+
209+
```json
210+
{
211+
"mcpServers": {
212+
"libtmux": {
213+
"command": "libtmux-mcp"
214+
}
215+
}
216+
}
217+
```
218+
`````
219+
`````````
12220

13-
Using a different client? See {ref}`installation` and {ref}`clients`.
221+
See {ref}`clients` for dev-checkout setup, full config-file locations, and common pitfalls.
14222

15223
## 2. Verify
16224

0 commit comments

Comments
 (0)