capture_pane

Java

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

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

All Java tools · JSON · Source

Arguments

history optional · boolean: Include scrollback rather than only the visible screen. Defaults to false.
Default: false.
max_lines optional · integer: Maximum lines, keeping the newest. Defaults to 200.
Default: 200.
pane_id required · string: The pane to act on, such as %1. Every listing tool returns these.

Schemas

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

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"
}

Tool annotations

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