Skip to content

Commit b2aabf0

Browse files
committed
docs: Promote safety to top-level page
why: Safety is a product differentiator and belongs in the main nav, not buried under topics/. what: - Move docs/topics/safety.md to docs/safety.md - Add tool annotations table (readOnly, destructive, idempotent per tool) - Delete docs/topics/index.md (orphan toctree wrapper)
1 parent 83270fb commit b2aabf0

2 files changed

Lines changed: 34 additions & 7 deletions

File tree

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,37 @@ Destructive tools include safeguards against self-harm:
6060
- `kill_pane` refuses to kill the pane running the MCP server
6161

6262
These protections use the `TMUX_PANE` environment variable to detect the caller's own pane.
63+
64+
## Tool annotations
65+
66+
Each tool carries MCP tool annotations that hint at its behavior:
67+
68+
| Tool | Tier | readOnly | destructive | idempotent |
69+
|------|------|----------|-------------|------------|
70+
| `list_sessions` | readonly | true | false | true |
71+
| `get_server_info` | readonly | true | false | true |
72+
| `list_windows` | readonly | true | false | true |
73+
| `list_panes` | readonly | true | false | true |
74+
| `capture_pane` | readonly | true | false | true |
75+
| `get_pane_info` | readonly | true | false | true |
76+
| `search_panes` | readonly | true | false | true |
77+
| `wait_for_text` | readonly | true | false | true |
78+
| `show_option` | readonly | true | false | true |
79+
| `show_environment` | readonly | true | false | true |
80+
| `create_session` | mutating | false | false | false |
81+
| `create_window` | mutating | false | false | false |
82+
| `split_window` | mutating | false | false | false |
83+
| `send_keys` | mutating | false | false | false |
84+
| `rename_session` | mutating | false | false | true |
85+
| `rename_window` | mutating | false | false | true |
86+
| `resize_pane` | mutating | false | false | true |
87+
| `resize_window` | mutating | false | false | true |
88+
| `set_pane_title` | mutating | false | false | true |
89+
| `clear_pane` | mutating | false | false | true |
90+
| `select_layout` | mutating | false | false | true |
91+
| `set_option` | mutating | false | false | true |
92+
| `set_environment` | mutating | false | false | true |
93+
| `kill_server` | destructive | false | true | false |
94+
| `kill_session` | destructive | false | true | false |
95+
| `kill_window` | destructive | false | true | false |
96+
| `kill_pane` | destructive | false | true | false |

docs/topics/index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)