capture_pane

Python
Ruby Unavailable
Lua Unavailable
TypeScript
Rust
Go
Java
.NET
C++
Swift

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

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": {
    "lines": {
      "items": {
        "type": "string"
      },
      "type": [
        "array"
      ]
    },
    "paneId": {
      "type": "string"
    },
    "truncated": {
      "type": "boolean"
    },
    "truncatedBytes": {
      "type": "integer"
    },
    "truncatedLines": {
      "type": "integer"
    }
  },
  "required": [
    "paneId",
    "truncated"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "openWorldHint": true,
  "title": "Capture a pane"
}