Skip to content

Commit 3e38208

Browse files
committed
docs(tools): Show is_caller=false as the default example value
why: is_caller is null only when the MCP client runs outside tmux (no TMUX_PANE env var). An MCP agent running inside a tmux pane — the overwhelmingly common case — gets true or false depending on whether the targeted pane matches its own. Seeding every result example with `"is_caller": null` misrepresents the typical shape of a response and trains readers to expect an edge-case value. what: - docs/tools/panes.md: all 9 occurrences changed from `"is_caller": null` to `"is_caller": false` (example tool calls target panes like %0 that are not the implicit caller, so false is the realistic value). - docs/tools/windows.md: 3 occurrences changed likewise. The is_caller Pydantic field definition in models.py still allows None for the outside-tmux case — schema unchanged.
1 parent 624f1ee commit 3e38208

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/tools/panes.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Response:
8181
"pane_active": "1",
8282
"window_id": "@0",
8383
"session_id": "$0",
84-
"is_caller": null
84+
"is_caller": false
8585
}
8686
```
8787

@@ -130,7 +130,7 @@ Response:
130130
"FAIL: test_upload (AssertionError)",
131131
"3 tests: 2 passed, 1 failed"
132132
],
133-
"is_caller": null
133+
"is_caller": false
134134
}
135135
]
136136
```
@@ -226,7 +226,7 @@ Response:
226226
"title": null,
227227
"pane_current_command": "zsh",
228228
"pane_current_path": "/home/user/myproject",
229-
"is_caller": null
229+
"is_caller": false
230230
}
231231
```
232232

@@ -381,7 +381,7 @@ Response:
381381
"pane_active": "1",
382382
"window_id": "@0",
383383
"session_id": "$0",
384-
"is_caller": null
384+
"is_caller": false
385385
}
386386
```
387387

@@ -453,7 +453,7 @@ Response:
453453
"pane_active": "1",
454454
"window_id": "@0",
455455
"session_id": "$0",
456-
"is_caller": null
456+
"is_caller": false
457457
}
458458
```
459459

@@ -498,7 +498,7 @@ Response:
498498
"pane_active": "1",
499499
"window_id": "@0",
500500
"session_id": "$0",
501-
"is_caller": null
501+
"is_caller": false
502502
}
503503
```
504504

@@ -542,7 +542,7 @@ Response:
542542
"pane_active": "1",
543543
"window_id": "@0",
544544
"session_id": "$0",
545-
"is_caller": null
545+
"is_caller": false
546546
}
547547
```
548548

@@ -643,7 +643,7 @@ Response:
643643
"pane_active": "1",
644644
"window_id": "@0",
645645
"session_id": "$0",
646-
"is_caller": null
646+
"is_caller": false
647647
}
648648
```
649649

@@ -686,7 +686,7 @@ Response:
686686
"pane_active": "1",
687687
"window_id": "@0",
688688
"session_id": "$0",
689-
"is_caller": null
689+
"is_caller": false
690690
}
691691
```
692692

docs/tools/windows.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Response:
9494
"pane_active": "1",
9595
"window_id": "@0",
9696
"session_id": "$0",
97-
"is_caller": null
97+
"is_caller": false
9898
},
9999
{
100100
"pane_id": "%1",
@@ -108,7 +108,7 @@ Response:
108108
"pane_active": "0",
109109
"window_id": "@0",
110110
"session_id": "$0",
111-
"is_caller": null
111+
"is_caller": false
112112
}
113113
]
114114
```
@@ -194,7 +194,7 @@ Response:
194194
"pane_active": "0",
195195
"window_id": "@0",
196196
"session_id": "$0",
197-
"is_caller": null
197+
"is_caller": false
198198
}
199199
```
200200

0 commit comments

Comments
 (0)