MCPAPI Reference

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

snapshot_pane

Returns what a pane shows and its metadata, as list_panes describes a pane, in one call. Use it when both are needed; capture_pane alone reads less. Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted.

All Java tools · JSON · Source

Arguments

history optional · boolean
Include scrollback rather than only the visible screen. Defaults to false.

Default: false.

max_lines optional · integer
Maximum lines, keeping the newest. Defaults to 200.

Default: 200.

pane_id required · string
The pane to act on, such as %1. Every listing tool returns these.

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema
{
"additionalProperties": false,
"properties": {
"history": {
"default": false,
"description": "Include scrollback rather than only the visible screen. Defaults to false.",
"type": "boolean"
},
"max_lines": {
"default": 200,
"description": "Maximum lines, keeping the newest. Defaults to 200.",
"type": "integer"
},
"pane_id": {
"description": "The pane to act on, such as %1. Every listing tool returns these.",
"type": "string"
}
},
"required": [
"pane_id"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"content": {
"items": {
"type": "string"
},
"type": "array"
},
"cursor": {
"type": "string"
},
"lines_dropped": {
"type": "integer"
},
"pane": {
"type": "object"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"pane",
"content",
"cursor",
"truncated",
"lines_dropped"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Snapshot a pane"
}
Esc

Type to search.