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. Read a pane’s visible content together with its cursor position, size and running command, in one call. Prefer this over capture_pane plus list_panes: it is one round trip and the cursor is guaranteed to describe the text returned with it.

All C# tools · JSON · Source

Arguments

maxLines optional · integer | null
Maximum returned lines, newest kept. Omit for the server default, 500 unless LIBTMUX_MCP_MAX_LINES sets another.

Default: null.

paneId optional · string | null
A pane id. Omit for this server's own pane, or else the one the first session shows.

Default: null.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"maxLines": {
"default": null,
"description": "Maximum returned lines, newest kept. Omit for the server default, 500 unless LIBTMUX_MCP_MAX_LINES sets another.",
"maximum": 2147483647,
"minimum": -2147483648,
"type": [
"integer",
"null"
]
},
"paneId": {
"default": null,
"description": "A pane id. Omit for this server's own pane, or else the one the first session shows.",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Output schema
{
"properties": {
"alternateScreen": {
"type": "boolean"
},
"content": {
"properties": {
"droppedBytes": {
"type": "integer"
},
"droppedLines": {
"type": "integer"
},
"lines": {
"items": {
"type": "string"
},
"type": "array"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"lines",
"truncated",
"droppedLines",
"droppedBytes"
],
"type": "object"
},
"cursorX": {
"type": [
"integer",
"null"
]
},
"cursorY": {
"type": [
"integer",
"null"
]
},
"pane": {
"properties": {
"active": {
"type": "boolean"
},
"currentCommand": {
"type": [
"string",
"null"
]
},
"currentPath": {
"type": [
"string",
"null"
]
},
"dead": {
"type": "boolean"
},
"height": {
"type": "integer"
},
"historyLimit": {
"type": [
"integer",
"null"
]
},
"historySize": {
"type": [
"integer",
"null"
]
},
"index": {
"type": "integer"
},
"inMode": {
"type": "boolean"
},
"isCaller": {
"type": "boolean"
},
"paneId": {
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
]
},
"sessionId": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"width": {
"type": "integer"
},
"windowId": {
"type": "string"
},
"zoomed": {
"type": "boolean"
}
},
"required": [
"paneId",
"windowId",
"sessionId",
"index",
"width",
"height",
"title",
"active",
"dead",
"zoomed",
"inMode",
"currentCommand",
"currentPath",
"pid",
"historySize",
"historyLimit",
"isCaller"
],
"type": "object"
}
},
"required": [
"pane",
"content",
"cursorX",
"cursorY",
"alternateScreen"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Snapshot pane"
}
Esc

Type to search.