Skip to content

Commit a854473

Browse files
committed
docs(tools): Add response examples to 15 tools that lacked them
why: 15 of 27 tools had no response examples, making it hard for agents and humans to predict output shapes without trial calls. what: - panes.md: get_pane_info, set_pane_title, clear_pane, resize_pane, kill_pane - sessions.md: get_server_info, kill_session, kill_server - windows.md: list_panes, rename_window, select_layout, resize_window, kill_window - options.md: show_environment, set_environment - All responses derived from real MCP outputs, anonymized
1 parent 7d7aa4b commit a854473

4 files changed

Lines changed: 376 additions & 0 deletions

File tree

docs/tools/options.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,29 @@ Response:
4242

4343
**Side effects:** None. Readonly.
4444

45+
**Example:**
46+
47+
```json
48+
{
49+
"tool": "show_environment",
50+
"arguments": {}
51+
}
52+
```
53+
54+
Response:
55+
56+
```json
57+
{
58+
"variables": {
59+
"SHELL": "/bin/zsh",
60+
"TERM": "xterm-256color",
61+
"HOME": "/home/user",
62+
"USER": "user",
63+
"LANG": "C.UTF-8"
64+
}
65+
}
66+
```
67+
4568
```{fastmcp-tool-input} env_tools.show_environment
4669
```
4770

@@ -89,5 +112,27 @@ Response:
89112

90113
**Side effects:** Sets the variable in the tmux server.
91114

115+
**Example:**
116+
117+
```json
118+
{
119+
"tool": "set_environment",
120+
"arguments": {
121+
"name": "MY_VAR",
122+
"value": "hello"
123+
}
124+
}
125+
```
126+
127+
Response:
128+
129+
```json
130+
{
131+
"name": "MY_VAR",
132+
"value": "hello",
133+
"status": "set"
134+
}
135+
```
136+
92137
```{fastmcp-tool-input} env_tools.set_environment
93138
```

docs/tools/panes.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,36 @@ other metadata without reading the terminal content.
5555

5656
**Side effects:** None. Readonly.
5757

58+
**Example:**
59+
60+
```json
61+
{
62+
"tool": "get_pane_info",
63+
"arguments": {
64+
"pane_id": "%0"
65+
}
66+
}
67+
```
68+
69+
Response:
70+
71+
```json
72+
{
73+
"pane_id": "%0",
74+
"pane_index": "0",
75+
"pane_width": "80",
76+
"pane_height": "24",
77+
"pane_current_command": "zsh",
78+
"pane_current_path": "/home/user/myproject",
79+
"pane_pid": "12345",
80+
"pane_title": "",
81+
"pane_active": "1",
82+
"window_id": "@0",
83+
"session_id": "$0",
84+
"is_caller": null
85+
}
86+
```
87+
5888
```{fastmcp-tool-input} pane_tools.get_pane_info
5989
```
6090

@@ -195,6 +225,37 @@ Keys sent to pane %2
195225

196226
**Side effects:** Changes the pane title.
197227

228+
**Example:**
229+
230+
```json
231+
{
232+
"tool": "set_pane_title",
233+
"arguments": {
234+
"pane_id": "%0",
235+
"title": "build"
236+
}
237+
}
238+
```
239+
240+
Response:
241+
242+
```json
243+
{
244+
"pane_id": "%0",
245+
"pane_index": "0",
246+
"pane_width": "80",
247+
"pane_height": "24",
248+
"pane_current_command": "zsh",
249+
"pane_current_path": "/home/user/myproject",
250+
"pane_pid": "12345",
251+
"pane_title": "build",
252+
"pane_active": "1",
253+
"window_id": "@0",
254+
"session_id": "$0",
255+
"is_caller": null
256+
}
257+
```
258+
198259
```{fastmcp-tool-input} pane_tools.set_pane_title
199260
```
200261

@@ -207,6 +268,23 @@ Keys sent to pane %2
207268

208269
**Side effects:** Clears the pane's visible content.
209270

271+
**Example:**
272+
273+
```json
274+
{
275+
"tool": "clear_pane",
276+
"arguments": {
277+
"pane_id": "%0"
278+
}
279+
}
280+
```
281+
282+
Response (string):
283+
284+
```text
285+
Pane cleared: %0
286+
```
287+
210288
```{fastmcp-tool-input} pane_tools.clear_pane
211289
```
212290

@@ -219,6 +297,37 @@ Keys sent to pane %2
219297

220298
**Side effects:** Changes pane size. May affect adjacent panes.
221299

300+
**Example:**
301+
302+
```json
303+
{
304+
"tool": "resize_pane",
305+
"arguments": {
306+
"pane_id": "%0",
307+
"height": 15
308+
}
309+
}
310+
```
311+
312+
Response:
313+
314+
```json
315+
{
316+
"pane_id": "%0",
317+
"pane_index": "0",
318+
"pane_width": "80",
319+
"pane_height": "15",
320+
"pane_current_command": "zsh",
321+
"pane_current_path": "/home/user/myproject",
322+
"pane_pid": "12345",
323+
"pane_title": "",
324+
"pane_active": "1",
325+
"window_id": "@0",
326+
"session_id": "$0",
327+
"is_caller": null
328+
}
329+
```
330+
222331
```{fastmcp-tool-input} pane_tools.resize_pane
223332
```
224333

@@ -234,5 +343,22 @@ without affecting sibling panes.
234343

235344
**Side effects:** Destroys the pane. Not reversible.
236345

346+
**Example:**
347+
348+
```json
349+
{
350+
"tool": "kill_pane",
351+
"arguments": {
352+
"pane_id": "%1"
353+
}
354+
}
355+
```
356+
357+
Response (string):
358+
359+
```text
360+
Pane killed: %1
361+
```
362+
237363
```{fastmcp-tool-input} pane_tools.kill_pane
238364
```

docs/tools/sessions.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,27 @@ or inspect server-level state before creating sessions.
5151

5252
**Side effects:** None. Readonly.
5353

54+
**Example:**
55+
56+
```json
57+
{
58+
"tool": "get_server_info",
59+
"arguments": {}
60+
}
61+
```
62+
63+
Response:
64+
65+
```json
66+
{
67+
"is_alive": true,
68+
"socket_name": null,
69+
"socket_path": null,
70+
"session_count": 2,
71+
"version": "3.6a"
72+
}
73+
```
74+
5475
```{fastmcp-tool-input} server_tools.get_server_info
5576
```
5677

@@ -141,6 +162,23 @@ windows and panes in the session.
141162

142163
**Side effects:** Destroys the session and all its contents. Not reversible.
143164

165+
**Example:**
166+
167+
```json
168+
{
169+
"tool": "kill_session",
170+
"arguments": {
171+
"session_name": "old-workspace"
172+
}
173+
}
174+
```
175+
176+
Response (string):
177+
178+
```text
179+
Session killed: old-workspace
180+
```
181+
144182
```{fastmcp-tool-input} session_tools.kill_session
145183
```
146184

@@ -156,5 +194,20 @@ session, window, and pane.
156194

157195
**Side effects:** Destroys everything. Not reversible.
158196

197+
**Example:**
198+
199+
```json
200+
{
201+
"tool": "kill_server",
202+
"arguments": {}
203+
}
204+
```
205+
206+
Response (string):
207+
208+
```text
209+
Server killed
210+
```
211+
159212
```{fastmcp-tool-input} server_tools.kill_server
160213
```

0 commit comments

Comments
 (0)