show_buffer

Read back the contents of an MCP-owned buffer.

Output is tail-preserved: when the buffer exceeds max_lines the oldest lines are dropped and :attr:~libtmux_mcp.models.BufferContent.content_truncated is set so the caller can tell truncation happened and opt in to a full read via max_lines=None. This mirrors capture_pane — one consistent bounded-output contract across read-heavy tools so a pathological load_buffer staging cannot blow the agent’s context window on a single show_buffer call.

All Python tools · JSON · Source

Arguments

buffer_name required · string

Must match the full MCP-namespaced form.

max_lines optional

Maximum number of lines to return. Defaults to :data:`SHOW_BUFFER_DEFAULT_MAX_LINES`. Pass ``None`` for no truncation.

Default: 500.

socket_name optional

tmux socket name.

Default: null.

Schemas

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

{
  "additionalProperties": false,
  "properties": {
    "buffer_name": {
      "description": "Must match the full MCP-namespaced form.",
      "type": "string"
    },
    "max_lines": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": 500,
      "description": "Maximum number of lines to return. Defaults to\n:data:`SHOW_BUFFER_DEFAULT_MAX_LINES`. Pass ``None`` for no\ntruncation."
    },
    "socket_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "tmux socket name."
    }
  },
  "required": [
    "buffer_name"
  ],
  "type": "object"
}

{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false
}