Skip to content

Commit 3045cbc

Browse files
committed
docs(fix[tools]): Correct stale tool examples that teach wrong API
why: Docs taught wrong parameters/responses for 3 tools, causing agents to generate invalid tool calls. what: - Remove nonexistent `attach` parameter from create_session side effects - Fix kill_server response: "Server killed" → "Server killed successfully" - Fix kill_window example: session_name+window_name → window_id - Fix kill_window response: window name → window ID
1 parent 4ff797b commit 3045cbc

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

docs/tools/sessions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ container — create one before creating windows or panes.
8686
**Avoid when** a session with the target name already exists — check with
8787
{tooliconl}`list-sessions` first, or the command will fail.
8888

89-
**Side effects:** Creates a new tmux session. Attaches if `attach` is true.
89+
**Side effects:** Creates a new tmux session with one window and one pane.
9090

9191
**Example:**
9292

@@ -206,7 +206,7 @@ session, window, and pane.
206206
Response (string):
207207

208208
```text
209-
Server killed
209+
Server killed successfully
210210
```
211211

212212
```{fastmcp-tool-input} server_tools.kill_server

docs/tools/windows.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,16 +343,15 @@ Response:
343343
{
344344
"tool": "kill_window",
345345
"arguments": {
346-
"session_name": "dev",
347-
"window_name": "old-logs"
346+
"window_id": "@1"
348347
}
349348
}
350349
```
351350

352351
Response (string):
353352

354353
```text
355-
Window killed: old-logs
354+
Window killed: @1
356355
```
357356

358357
```{fastmcp-tool-input} window_tools.kill_window

0 commit comments

Comments
 (0)