MCPconceptTools

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

tool MCPlatest

capture_pane

capture_pane( history?: boolean, max_lines?: integer, pane_id: string, )
tool [source]

Returns what a pane shows now, its newest lines first to go when bounded, and a cursor for capture_since. Use it to read a pane once. Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted.

MCP request method
tools/call Send capture_pane as the tool name, with the arguments below.

Arguments#

  • history? = false (boolean) #

    Include scrollback rather than only the visible screen. Defaults to false.

  • max_lines? = 200 (integer) #

    Maximum lines, keeping the newest. Defaults to 200.

  • pane_id (string) #

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

No other arguments are accepted.

Result#

Returns object

No other properties are accepted.

Annotations#

destructiveHint
true
idempotentHint
false
openWorldHint
true
readOnlyHint
false
title
"Capture a pane"

Protocol data#

Use the complete advertised contract for validation and client integration.

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": {
"type": "integer"
},
"lines_dropped": {
"type": "integer"
},
"note": {
"type": "string"
},
"pane_id": {
"type": "string"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"pane_id",
"lines",
"content",
"truncated",
"lines_dropped",
"cursor"
],
"type": "object"
}
Esc

Type to search.

Reference previewOpen reference