# clear_pane_scrollback

Source: https://libtmux.org/en/ts/latest/mcp/tools/clear_pane_scrollback/

> Delete tmux state; accepts no command payload. Discard the retained scrollback history for one pane.

tool MCPlatest

MCP concept example

A working example of the core library. It can change without notice.

[What concept means](https://libtmux.org/en/meta/support/#concept-and-alpha)

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

  tool \[[source](https://github.com/libtmux/libtmux-ts/blob/46cccfef2a546de55ce8b308249b8c76339089a0/packages/mcp/src/tools/target.ts#L575)][¶](https://libtmux.org/en/ts/latest/mcp/tools/clear_pane_scrollback/#mcp.tool.clear_pane_scrollback)

  Delete tmux state; accepts no command payload. Discard the retained scrollback history for one pane.

  * MCP request method

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

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

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

    Stable pane id, e.g. %1.

    * pattern

      `"^%\\d+$"`

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

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

  * **[`cleared`](https://libtmux.org/en/ts/latest/mcp/tools/clear_pane_scrollback/#mcp.tool.clear_pane_scrollback.output%2Fproperties%2Fcleared)** ([string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)"))

    Stable pane id, e.g. %1.

    * pattern

      `"^%\\d+$"`

  No other properties are accepted.

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

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

    `true`

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

    `false`

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

    `true`

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

    `false`

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

  Use the complete advertised contract for validation and client integration.

  Input schema

  ```json
  {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "properties": {
      "paneId": {
        "description": "Stable pane id, e.g. %1.",
        "pattern": "^%\\d+$",
        "type": "string"
      }
    },
    "required": [
      "paneId"
    ],
    "type": "object"
  }
  ```

  Output schema

  ```json
  {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "additionalProperties": false,
    "properties": {
      "cleared": {
        "description": "Stable pane id, e.g. %1.",
        "pattern": "^%\\d+$",
        "type": "string"
      }
    },
    "required": [
      "cleared"
    ],
    "type": "object"
  }
  ```
