Commit 052079d
committed
docs(tools): Correct snapshot_pane title example and document pipe_pane stop-case
why: Two result examples in docs/tools/panes.md drifted from the code:
1. snapshot_pane showed "title": "" but the tool coerces any falsy
title value to None via `title=parts[8] if parts[8] else None`
in pane_tools.py — so "" is literally unreachable and the only
truthful values are a non-empty string or null. Verified with a
live probe against a fresh pane (surfaced "title": "d", tmux's
default). Readers copying the example would have serialized data
that could never arrive over MCP.
2. pipe_pane only documented the start-case response string. The
side-effects paragraph tells readers to call with output_path=null
to stop, but no example showed the `"Piping stopped for pane %0"`
response that the tool returns in that branch (pane_tools.py:970).
Agents toggling the pipe had to guess the return shape.
what:
- Flip snapshot_pane's example title value from "" to null.
- Extend the pipe_pane section with a second example showing the
output_path=null call and its corresponding "Piping stopped ..."
response string.
No code changes; all existing result shapes verified against
src/libtmux_mcp/models.py, the _utils.py serializers, and each tool's
return path. Only these two examples needed correction.1 parent 82c6330 commit 052079d
1 file changed
Lines changed: 20 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
223 | 223 | | |
224 | 224 | | |
225 | 225 | | |
226 | | - | |
| 226 | + | |
227 | 227 | | |
228 | 228 | | |
229 | 229 | | |
| |||
576 | 576 | | |
577 | 577 | | |
578 | 578 | | |
579 | | - | |
| 579 | + | |
580 | 580 | | |
581 | 581 | | |
582 | 582 | | |
583 | 583 | | |
584 | 584 | | |
| 585 | + | |
| 586 | + | |
| 587 | + | |
| 588 | + | |
| 589 | + | |
| 590 | + | |
| 591 | + | |
| 592 | + | |
| 593 | + | |
| 594 | + | |
| 595 | + | |
| 596 | + | |
| 597 | + | |
| 598 | + | |
| 599 | + | |
| 600 | + | |
| 601 | + | |
| 602 | + | |
585 | 603 | | |
586 | 604 | | |
587 | 605 | | |
| |||
0 commit comments