Auto Light Dark

MCPAPI Reference

Choose documentation 3

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Browse documentation

MCPAPI Reference

On this page

clear_pane_scrollback

Deletes retained scrollback from one pane. Delete tmux state; accepts no command payload.

All Java tools · JSON · Source

Arguments

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": {
    "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": {
    "cleared": {
      "type": "boolean"
    },
    "pane_id": {
      "type": "string"
    }
  },
  "required": [
    "pane_id",
    "cleared"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false,
  "title": "Clear pane scrollback"
}