MCPpre-alphaAPI Reference

Choose documentation 3

stable

Current version

stable
English

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

libtmux_mcp.tools.buffer_tools.show_buffer

libtmux_mcp.tools.buffer_tools.show_buffer ( buffer_name: str, max_lines: int | None = SHOW_BUFFER_DEFAULT_MAX_LINES, socket_name: str | None = None, ) → BufferContent

Read back the contents of an MCP-owned buffer.

Description#

Output is tail-preserved: when the buffer exceeds max_lines the oldest lines are dropped and 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.

Parameters
Returns

BufferContent Structured result with buffer_name, content, and the truncation fields.

Esc

Type to search.

Reference preview Open reference