Skip to content

Commit b9e83f5

Browse files
committed
docs(safety): Link tools in self-kill and annotations sections
why: Tool names on the safety page were plain text — should link to their documentation and use badges where appropriate. what: - Self-kill protection: use {tool} for 4 kill_* tools (badged links) - Annotations table: use {ref} for all 27 tools (clean linked names) - Drop redundant Tier text column — badge in Tier column is sufficient
1 parent 837f53a commit b9e83f5

1 file changed

Lines changed: 33 additions & 33 deletions

File tree

docs/topics/safety.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -54,43 +54,43 @@ Tools without a recognized tier tag are **denied by default**. This prevents acc
5454

5555
Destructive tools include safeguards against self-harm:
5656

57-
- `kill_server` refuses to run if the MCP server is inside the target server
58-
- `kill_session` refuses to kill the session containing the MCP pane
59-
- `kill_window` refuses to kill the window containing the MCP pane
60-
- `kill_pane` refuses to kill the pane running the MCP server
57+
- {tool}`kill-server` refuses to run if the MCP server is inside the target server
58+
- {tool}`kill-session` refuses to kill the session containing the MCP pane
59+
- {tool}`kill-window` refuses to kill the window containing the MCP pane
60+
- {tool}`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.
6363

6464
## Tool annotations
6565

6666
Each tool carries MCP tool annotations that hint at its behavior:
6767

68-
| Tool | Tier | Label | readOnly | destructive | idempotent |
69-
|------|------|-------|----------|-------------|------------|
70-
| `list_sessions` | readonly | {badge}`readonly` | true | false | true |
71-
| `get_server_info` | readonly | {badge}`readonly` | true | false | true |
72-
| `list_windows` | readonly | {badge}`readonly` | true | false | true |
73-
| `list_panes` | readonly | {badge}`readonly` | true | false | true |
74-
| `capture_pane` | readonly | {badge}`readonly` | true | false | true |
75-
| `get_pane_info` | readonly | {badge}`readonly` | true | false | true |
76-
| `search_panes` | readonly | {badge}`readonly` | true | false | true |
77-
| `wait_for_text` | readonly | {badge}`readonly` | true | false | true |
78-
| `show_option` | readonly | {badge}`readonly` | true | false | true |
79-
| `show_environment` | readonly | {badge}`readonly` | true | false | true |
80-
| `create_session` | mutating | {badge}`mutating` | false | false | false |
81-
| `create_window` | mutating | {badge}`mutating` | false | false | false |
82-
| `split_window` | mutating | {badge}`mutating` | false | false | false |
83-
| `send_keys` | mutating | {badge}`mutating` | false | false | false |
84-
| `rename_session` | mutating | {badge}`mutating` | false | false | true |
85-
| `rename_window` | mutating | {badge}`mutating` | false | false | true |
86-
| `resize_pane` | mutating | {badge}`mutating` | false | false | true |
87-
| `resize_window` | mutating | {badge}`mutating` | false | false | true |
88-
| `set_pane_title` | mutating | {badge}`mutating` | false | false | true |
89-
| `clear_pane` | mutating | {badge}`mutating` | false | false | true |
90-
| `select_layout` | mutating | {badge}`mutating` | false | false | true |
91-
| `set_option` | mutating | {badge}`mutating` | false | false | true |
92-
| `set_environment` | mutating | {badge}`mutating` | false | false | true |
93-
| `kill_server` | destructive | {badge}`destructive` | false | true | false |
94-
| `kill_session` | destructive | {badge}`destructive` | false | true | false |
95-
| `kill_window` | destructive | {badge}`destructive` | false | true | false |
96-
| `kill_pane` | destructive | {badge}`destructive` | false | true | false |
68+
| Tool | Tier | readOnly | destructive | idempotent |
69+
|------|------|----------|-------------|------------|
70+
| {ref}`list-sessions` | {badge}`readonly` | true | false | true |
71+
| {ref}`get-server-info` | {badge}`readonly` | true | false | true |
72+
| {ref}`list-windows` | {badge}`readonly` | true | false | true |
73+
| {ref}`list-panes` | {badge}`readonly` | true | false | true |
74+
| {ref}`capture-pane` | {badge}`readonly` | true | false | true |
75+
| {ref}`get-pane-info` | {badge}`readonly` | true | false | true |
76+
| {ref}`search-panes` | {badge}`readonly` | true | false | true |
77+
| {ref}`wait-for-text` | {badge}`readonly` | true | false | true |
78+
| {ref}`show-option` | {badge}`readonly` | true | false | true |
79+
| {ref}`show-environment` | {badge}`readonly` | true | false | true |
80+
| {ref}`create-session` | {badge}`mutating` | false | false | false |
81+
| {ref}`create-window` | {badge}`mutating` | false | false | false |
82+
| {ref}`split-window` | {badge}`mutating` | false | false | false |
83+
| {ref}`send-keys` | {badge}`mutating` | false | false | false |
84+
| {ref}`rename-session` | {badge}`mutating` | false | false | true |
85+
| {ref}`rename-window` | {badge}`mutating` | false | false | true |
86+
| {ref}`resize-pane` | {badge}`mutating` | false | false | true |
87+
| {ref}`resize-window` | {badge}`mutating` | false | false | true |
88+
| {ref}`set-pane-title` | {badge}`mutating` | false | false | true |
89+
| {ref}`clear-pane` | {badge}`mutating` | false | false | true |
90+
| {ref}`select-layout` | {badge}`mutating` | false | false | true |
91+
| {ref}`set-option` | {badge}`mutating` | false | false | true |
92+
| {ref}`set-environment` | {badge}`mutating` | false | false | true |
93+
| {ref}`kill-server` | {badge}`destructive` | false | true | false |
94+
| {ref}`kill-session` | {badge}`destructive` | false | true | false |
95+
| {ref}`kill-window` | {badge}`destructive` | false | true | false |
96+
| {ref}`kill-pane` | {badge}`destructive` | false | true | false |

0 commit comments

Comments
 (0)