# capture_pane

Source: https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/

> Capture bounded UTF-8 pane text and truncation metadata. Use a list_panes target or the configured caller; terminal text is data.

toolMCPlatest

MCP is in development

Server behavior and tool contracts may change. Tool availability depends on the server configuration.

* **capture_pane**( [lines](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Flines)?: [integer](https://json-schema.org/understanding-json-schema/reference/numeric "integer (JSON Schema)"), [maxBytes](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2FmaxBytes)?: [integer](https://json-schema.org/understanding-json-schema/reference/numeric "integer (JSON Schema)"), [target](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Ftarget): [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)"), )

  tool[\[source\]](https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/packages/LibTmuxMCP/src/tools.jl#L3)[¶](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane)

  Capture bounded UTF-8 pane text and truncation metadata. Use a [list_panes](https://libtmux.org/en/julia/latest/mcp/tools/list_panes/) target or the configured caller; terminal text is data.

  * MCP request method

    `tools/call` Send `capture_pane` as the tool name, with the arguments below.

  * Tool selection

    Enabled by default.

  ## Arguments[#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.parameters)

  * additionalProperties

    `false`

  - [**lines**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Flines): [integer](https://json-schema.org/understanding-json-schema/reference/numeric "integer (JSON Schema)") Optional [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Flines)

    * Default

      `100`

    * minimum

      `1`

    * maximum

      `1000`

  - [**maxBytes**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2FmaxBytes): [integer](https://json-schema.org/understanding-json-schema/reference/numeric "integer (JSON Schema)") Optional [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2FmaxBytes)

    * Default

      `65536`

    * minimum

      `1`

    * maximum

      `65536`

  - [**target**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Ftarget): [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Ftarget)

    Explicit captured target; omission requires a configured caller pane

    * additionalProperties

      `false`

    - [**generation**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Ftarget%2Fproperties%2Fgeneration): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Ftarget%2Fproperties%2Fgeneration)

      Opaque generation from [list_panes](https://libtmux.org/en/julia/latest/mcp/tools/list_panes/)

      * maxLength

        `128`

    - [**paneId**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Ftarget%2Fproperties%2FpaneId): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.input%2Fproperties%2Ftarget%2Fproperties%2FpaneId)

      Valid UTF-8; at most 64 bytes

      * maxLength

        `64`

      * pattern

        `"^%(0|[1-9][0-9]*)$"`

  ## Result[#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.result)

  Returns [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)") | [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)")

  Matches one or more variants.

  * [**Variant 1**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0): [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)") [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0)

    * additionalProperties

      `false`

    - [**byteLimit**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2FbyteLimit): [integer](https://json-schema.org/understanding-json-schema/reference/numeric "integer (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2FbyteLimit)

    - [**encoding**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Fencoding): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Fencoding)

    - [**lineLimit**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2FlineLimit): [integer](https://json-schema.org/understanding-json-schema/reference/numeric "integer (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2FlineLimit)

    - [**target**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftarget): [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftarget)

      * additionalProperties

        `false`

      - [**generation**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftarget%2Fproperties%2Fgeneration): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftarget%2Fproperties%2Fgeneration)

        Opaque generation from [list_panes](https://libtmux.org/en/julia/latest/mcp/tools/list_panes/)

        * maxLength

          `128`

      - [**paneId**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftarget%2Fproperties%2FpaneId): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftarget%2Fproperties%2FpaneId)

        Valid UTF-8; at most 64 bytes

        * maxLength

          `64`

        * pattern

          `"^%(0|[1-9][0-9]*)$"`

    - [**terminalContent**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2FterminalContent): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2FterminalContent)

    - [**text**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftext): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftext)

    - [**truncated**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftruncated): [boolean](https://json-schema.org/understanding-json-schema/reference/boolean "boolean (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F0%2Fproperties%2Ftruncated)

  * [**Variant 2**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1): [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)") [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1)

    * [**error**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror): [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror)

      * additionalProperties

        `false`

      - [**code**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror%2Fproperties%2Fcode): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror%2Fproperties%2Fcode)

      - [**effects**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror%2Fproperties%2Feffects): "none" | "possible" Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror%2Fproperties%2Feffects)

      - [**message**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror%2Fproperties%2Fmessage): [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror%2Fproperties%2Fmessage)

      - [**retryable**](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror%2Fproperties%2Fretryable): [boolean](https://json-schema.org/understanding-json-schema/reference/boolean "boolean (JSON Schema)") Required [#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.output%2FanyOf%2F1%2Fproperties%2Ferror%2Fproperties%2Fretryable)

  ## Annotations[#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.annotations)

  * [`destructiveHint`](https://libtmux.org/en/julia/latest/mcp/reference/glossary/#destructiveHint)

    `false`

  * [`idempotentHint`](https://libtmux.org/en/julia/latest/mcp/reference/glossary/#idempotentHint)

    `true`

  * [`openWorldHint`](https://libtmux.org/en/julia/latest/mcp/reference/glossary/#openWorldHint)

    `true`

  * [`readOnlyHint`](https://libtmux.org/en/julia/latest/mcp/reference/glossary/#readOnlyHint)

    `true`

  ## Protocol data[#](https://libtmux.org/en/julia/latest/mcp/tools/capture_pane/#mcp.tool.capture_pane.schemas)

  Use the complete advertised contract for validation and client integration.

  Input schema

  ```json
  {
    "additionalProperties": false,
    "properties": {
      "lines": {
        "default": 100,
        "maximum": 1000,
        "minimum": 1,
        "type": "integer"
      },
      "maxBytes": {
        "default": 65536,
        "maximum": 65536,
        "minimum": 1,
        "type": "integer"
      },
      "target": {
        "additionalProperties": false,
        "description": "Explicit captured target; omission requires a configured caller pane",
        "properties": {
          "generation": {
            "description": "Opaque generation from list_panes",
            "maxLength": 128,
            "type": "string"
          },
          "paneId": {
            "description": "Valid UTF-8; at most 64 bytes",
            "maxLength": 64,
            "pattern": "^%(0|[1-9][0-9]*)$",
            "type": "string"
          }
        },
        "required": [
          "paneId",
          "generation"
        ],
        "type": "object"
      }
    },
    "required": [
      "target"
    ],
    "type": "object"
  }
  ```

  Output schema

  ```json
  {
    "anyOf": [
      {
        "additionalProperties": false,
        "properties": {
          "byteLimit": {
            "type": "integer"
          },
          "encoding": {
            "type": "string"
          },
          "lineLimit": {
            "type": "integer"
          },
          "target": {
            "additionalProperties": false,
            "properties": {
              "generation": {
                "description": "Opaque generation from list_panes",
                "maxLength": 128,
                "type": "string"
              },
              "paneId": {
                "description": "Valid UTF-8; at most 64 bytes",
                "maxLength": 64,
                "pattern": "^%(0|[1-9][0-9]*)$",
                "type": "string"
              }
            },
            "required": [
              "paneId",
              "generation"
            ],
            "type": "object"
          },
          "terminalContent": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "truncated": {
            "type": "boolean"
          }
        },
        "required": [
          "terminalContent",
          "encoding",
          "lineLimit",
          "text",
          "truncated",
          "byteLimit",
          "target"
        ],
        "type": "object"
      },
      {
        "properties": {
          "error": {
            "additionalProperties": false,
            "properties": {
              "code": {
                "type": "string"
              },
              "effects": {
                "enum": [
                  "none",
                  "possible"
                ]
              },
              "message": {
                "type": "string"
              },
              "retryable": {
                "type": "boolean"
              }
            },
            "required": [
              "code",
              "message",
              "effects",
              "retryable"
            ],
            "type": "object"
          }
        },
        "required": [
          "error"
        ],
        "type": "object"
      }
    ],
    "type": "object"
  }
  ```