tool MCPlatest

`list_panes`

list_panes()

tool [source]¶

List every pane on the server. Inspect tmux metadata; accepts no client-supplied executable input.

MCP request method: tools/call Send list_panes as the tool name, with the arguments below.

Arguments#

No named arguments.

Result#

Returns object

panes (Array<PaneView>) #

The panes, in tmux’s own order.

Types#

PaneView: object type ¶

One pane, as the protocol sees it.

active (boolean) #

Whether this is the window’s active pane.
caller (Relation) #

Whether this is the pane the MCP server itself runs in.

self only on a confirmed match of both socket and pane id; other for every pane that is not, including one this crate cannot prove either way; unknown when the server is not running inside tmux, so the question has no answer.
command (string | null) #

The command currently running.
id (string) #

The %-prefixed tmux identity.
path (string | null) #

The pane’s working directory.
window_id (string) #

The window that contains the pane.

Relation: "unknown" | "self" | "other" type ¶

How a pane relates to the process answering the request.

Three values rather than a boolean, because “not the caller’s pane” and “there is no caller” are different answers and an agent acts differently on each.

Matches exactly one variant.

Variant 1 ("unknown") #

This process is not running inside tmux, so no pane is its own.
Variant 2 ("self") #

Confirmed: the same tmux server, and the same pane.
Variant 3 ("other") #

Some other pane, or a pane this crate cannot prove is the caller’s.

Annotations#

destructiveHint: false
idempotentHint: true
openWorldHint: false
readOnlyHint: true
title: "List Panes"

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "additionalProperties": false,
  "properties": {},
  "type": "object"
}

Output schema

{
  "$defs": {
    "PaneView": {
      "description": "One pane, as the protocol sees it.",
      "properties": {
        "active": {
          "description": "Whether this is the window's active pane.",
          "type": "boolean"
        },
        "caller": {
          "$ref": "#/$defs/Relation",
          "description": "Whether this is the pane the MCP server itself runs in.\n\n`self` only on a confirmed match of both socket and pane id; `other`\nfor every pane that is not, including one this crate cannot prove\neither way; `unknown` when the server is not running inside tmux, so\nthe question has no answer."
        },
        "command": {
          "description": "The command currently running.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "The `%`-prefixed tmux identity.",
          "type": "string"
        },
        "path": {
          "description": "The pane's working directory.",
          "type": [
            "string",
            "null"
          ]
        },
        "window_id": {
          "description": "The window that contains the pane.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "window_id",
        "command",
        "path",
        "active",
        "caller"
      ],
      "type": "object"
    },
    "Relation": {
      "description": "How a pane relates to the process answering the request.\n\nThree values rather than a boolean, because \"not the caller's pane\" and\n\"there is no caller\" are different answers and an agent acts differently on\neach.",
      "oneOf": [
        {
          "const": "unknown",
          "description": "This process is not running inside tmux, so no pane is its own.",
          "type": "string"
        },
        {
          "const": "self",
          "description": "Confirmed: the same tmux server, and the same pane.",
          "type": "string"
        },
        {
          "const": "other",
          "description": "Some other pane, or a pane this crate cannot prove is the caller's.",
          "type": "string"
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "panes": {
      "description": "The panes, in tmux's own order.",
      "items": {
        "$ref": "#/$defs/PaneView"
      },
      "type": "array"
    }
  },
  "required": [
    "panes"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`list_panes`

Arguments#

Result#

Types#

`PaneView`: object

`Relation`: "unknown" | "self" | "other"

Annotations#

Protocol data#

Arguments#

Result#

Types#

PaneView: object

Relation: "unknown" | "self" | "other"

Annotations#

Protocol data#

`PaneView`: object

`Relation`: "unknown" | "self" | "other"