show_buffer
- show_buffer( buffer_name: string, max_lines?: integer | null, socket_name?: string | null, )
-
Read back the contents of an MCP-owned buffer.
Output is tail-preserved: when the buffer exceeds
max_linesthe oldest lines are dropped andcontent_truncatedis set so the caller can tell truncation happened and opt in to a full read viamax_lines=None. This mirrorscapture_pane— one consistent bounded-output contract across read-heavy tools so a pathologicalload_bufferstaging cannot blow the agent’s context window on a singleshow_buffercall.- MCP request method
tools/callSendshow_bufferas the tool name, with the arguments below.
Arguments#
-
Must match the full MCP-namespaced form.
-
max_lines? =500(integer | null) #Maximum number of lines to return. Defaults to
SHOW_BUFFER_DEFAULT_MAX_LINES. PassNonefor no truncation. -
socket_name? =null(string | null) #tmux socket name.
No other arguments are accepted.
Result#
This server does not advertise an output schema for this tool. Its description defines the returned content.
Annotations#
destructiveHinttrueidempotentHintfalseopenWorldHinttruereadOnlyHintfalse
Protocol data#
Use the complete advertised contract for validation and client integration.
Input schema
{"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"}