tool MCPlatest

`capture_pane`

capture_pane( history?: boolean, max_lines?: integer, pane_id: string, styles?: boolean, )

tool [source]¶

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

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

Arguments#

history? (boolean) #

include scrollback as well as the visible screen
max_lines? (integer) #

maximum lines, keeping the newest
pane_id (string) #

the pane id, such as %1
styles? (boolean) #

return terminal colour and attribute escape sequences raw in the lines; off by default

No other arguments are accepted.

Result#

Returns object

lines? (Array<string>) #
paneId (string) #
truncated (boolean) #
truncatedBytes? (integer) #
truncatedLines? (integer) #

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": {
      "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"
    },
    "styles": {
      "description": "return terminal colour and attribute escape sequences raw in the lines; off by default",
      "type": "boolean"
    }
  },
  "required": [
    "pane_id"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "lines": {
      "items": {
        "type": "string"
      },
      "type": [
        "array"
      ]
    },
    "paneId": {
      "type": "string"
    },
    "truncated": {
      "type": "boolean"
    },
    "truncatedBytes": {
      "type": "integer"
    },
    "truncatedLines": {
      "type": "integer"
    }
  },
  "required": [
    "paneId",
    "truncated"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`capture_pane`

Arguments#

Result#

Annotations#

Protocol data#