# pipe_pane

Source: https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/

> Log a pane's live output to a file (or stop an active log).

tool MCPlatest

MCP is in development

Server behavior and tool contracts may change. Tool availability depends on the server configuration.

* **pipe_pane**( [append](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fappend)?: [boolean](https://json-schema.org/understanding-json-schema/reference/boolean "boolean (JSON Schema)"), [output_path](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Foutput_path)?: [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"), [pane_id](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fpane_id)?: [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"), [session_id](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fsession_id)?: [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"), [session_name](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fsession_name)?: [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"), [socket_name](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fsocket_name)?: [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"), [window_id](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fwindow_id)?: [string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"), )

  tool \[[source](https://github.com/tmux-python/libtmux-mcp/blob/4daddc0dfca96c43bf521d818bf91564e1434760/src/libtmux_mcp/tools/pane_tools/__init__.py#L174)][¶](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane)

  Log a pane’s live output to a file (or stop an active log).

  Streams everything written to the pane (stdout plus terminal control sequences) into a file on disk — the common use is `output_path="/tmp/pane.log"` to capture scrollback continuously while the agent watches for errors. When `output_path` is given, starts logging; when `output_path` is None, stops any active pipe for the pane.

  Warning

  This tool writes to arbitrary filesystem paths chosen by the MCP client. There is no allow-list; the server will create files anywhere the server process has write access. Treat this as elevated-risk: it is the broadest-reach tool in `execute`. If you run libtmux-mcp on untrusted input, consider `LIBTMUX_TOOLSETS=inspect` or run the server under a user with a scoped home directory. See [topics/trust](https://libtmux-mcp.git-pull.com/topics/trust/) for the full footgun list.

  * MCP request method

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

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

  * **[`append`](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fappend)**? = `true` ([boolean](https://json-schema.org/understanding-json-schema/reference/boolean "boolean (JSON Schema)"))

    Whether to append to the file. Default True. If False, overwrites.

  * **[`output_path`](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Foutput_path)**? = `null` ([string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"))

    File path to write output to. None stops piping.

  * **[`pane_id`](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fpane_id)**? = `null` ([string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"))

    Pane ID (e.g. ‘%1’).

  * **[`session_id`](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fsession_id)**? = `null` ([string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"))

    Session ID for pane resolution.

  * **[`session_name`](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fsession_name)**? = `null` ([string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"))

    Session name for pane resolution.

  * **[`socket_name`](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fsocket_name)**? = `null` ([string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"))

    tmux socket name.

  * **[`window_id`](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.input%2Fproperties%2Fwindow_id)**? = `null` ([string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)") | [null](https://json-schema.org/understanding-json-schema/reference/null "null (JSON Schema)"))

    Window ID for pane resolution.

  No other arguments are accepted.

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

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

  * **[`result`](https://libtmux.org/en/py/latest/mcp/tools/pipe_pane/#mcp.tool.pipe_pane.output%2Fproperties%2Fresult)** ([string](https://json-schema.org/understanding-json-schema/reference/string "string (JSON Schema)"))

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

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

    `true`

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

    `false`

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

    `true`

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

    `false`

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

  Use the complete advertised contract for validation and client integration.

  Input schema

  ```json
  {
    "additionalProperties": false,
    "properties": {
      "append": {
        "default": true,
        "description": "Whether to append to the file. Default True. If False, overwrites.",
        "type": "boolean"
      },
      "output_path": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "default": null,
        "description": "File path to write output to. None stops piping."
      },
      "pane_id": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "default": null,
        "description": "Pane ID (e.g. '%1')."
      },
      "session_id": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "default": null,
        "description": "Session ID for pane resolution."
      },
      "session_name": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "default": null,
        "description": "Session name for pane resolution."
      },
      "socket_name": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "default": null,
        "description": "tmux socket name."
      },
      "window_id": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "default": null,
        "description": "Window ID for pane resolution."
      }
    },
    "type": "object"
  }
  ```

  Output schema

  ```json
  {
    "properties": {
      "result": {
        "type": "string"
      }
    },
    "required": [
      "result"
    ],
    "type": "object",
    "x-fastmcp-wrap-result": true
  }
  ```