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

Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted. Returns pane metadata and bounded terminal content together.

All Go tools · JSON · Source

Arguments

history optional · boolean
include scrollback as well as the visible screen
max_lines optional · integer
maximum lines, keeping the newest
pane_id required · string
the pane id, such as %1

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"history": {
"description": "include scrollback as well as the visible screen",
"type": "boolean"
},
"max_lines": {
"description": "maximum lines, keeping the newest",
"type": "integer"
},
"pane_id": {
"description": "the pane id, such as %1",
"type": "string"
}
},
"required": [
"pane_id"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"dead": {
"type": "boolean"
},
"exitStatus": {
"type": [
"null",
"integer"
]
},
"lines": {
"items": {
"type": "string"
},
"type": [
"array"
]
},
"pane": {
"additionalProperties": false,
"properties": {
"active": {
"type": "boolean"
},
"currentCommand": {
"type": "string"
},
"geometry": {
"additionalProperties": false,
"properties": {
"height": {
"type": "integer"
},
"left": {
"type": "integer"
},
"top": {
"type": "integer"
},
"width": {
"type": "integer"
}
},
"required": [
"left",
"top",
"width",
"height"
],
"type": "object"
},
"id": {
"type": "string"
},
"index": {
"type": "integer"
},
"isCaller": {
"type": [
"null",
"boolean"
]
},
"session": {
"type": "string"
},
"window": {
"type": "string"
},
"windowId": {
"type": "string"
}
},
"required": [
"id",
"session",
"window",
"windowId",
"index",
"currentCommand",
"active",
"geometry",
"isCaller"
],
"type": "object"
},
"truncated": {
"type": "boolean"
},
"truncatedBytes": {
"type": "integer"
},
"truncatedLines": {
"type": "integer"
}
},
"required": [
"lines",
"pane",
"dead",
"truncated"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"openWorldHint": true,
"title": "Snapshot a pane"
}
Esc

Type to search.