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

list_panes

TypeScript

Inspect tmux metadata; accepts no client-supplied executable input. Panes on this server, with the command each is running and its directory. Marks the pane this server runs in (isCallerPane) and panes a person is watching (isAttended). Metadata only — search_panes reads their contents.

All TypeScript tools · JSON · Source

Arguments

session optional · string
Session id ($1) or name.
window optional · string
Stable window id, e.g. @1.

Schemas

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

Input schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"session": {
"description": "Session id ($1) or name.",
"type": "string"
},
"window": {
"description": "Stable window id, e.g. @1.",
"pattern": "^@\\d+$",
"type": "string"
}
},
"type": "object"
}
Output schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"complete": {
"type": "boolean"
},
"omittedEntries": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"panes": {
"items": {
"additionalProperties": false,
"properties": {
"active": {
"description": "Whether this is its window's active pane.",
"type": "boolean"
},
"command": {
"description": "The command tmux reports running in it.",
"type": "string"
},
"cwd": {
"description": "Its current working directory.",
"type": "string"
},
"dead": {
"description": "Whether its process exited and remain-on-exit kept it.",
"type": "boolean"
},
"height": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"id": {
"description": "Stable pane id. Prefer this for entity-scoped targeting.",
"pattern": "^%\\d+$",
"type": "string"
},
"index": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"isAttended": {
"description": "A person is currently looking at this pane.",
"type": "boolean"
},
"isCallerPane": {
"description": "This is the pane this MCP server runs in.",
"type": "boolean"
},
"metadataComplete": {
"description": "Whether every projected metadata string is complete.",
"type": "boolean"
},
"omittedMetadataBytes": {
"description": "UTF-8 bytes omitted from projected metadata strings.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"omittedPlacements": {
"description": "Later placements omitted.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"placements": {
"description": "Retained session and window indexes through which this pane is reachable.",
"items": {
"additionalProperties": false,
"properties": {
"index": {
"description": "The window index in this session.",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"sessionId": {
"description": "Stable session id, e.g. $1.",
"pattern": "^\\$\\d+$",
"type": "string"
},
"sessionName": {
"type": "string"
}
},
"required": [
"index",
"sessionId",
"sessionName"
],
"type": "object"
},
"type": "array"
},
"placementsComplete": {
"description": "Whether placements contains every placement.",
"type": "boolean"
},
"title": {
"type": "string"
},
"width": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"windowId": {
"description": "Stable window id, e.g. @1.",
"pattern": "^@\\d+$",
"type": "string"
},
"windowName": {
"type": "string"
}
},
"required": [
"active",
"command",
"cwd",
"dead",
"height",
"id",
"index",
"isAttended",
"isCallerPane",
"metadataComplete",
"omittedMetadataBytes",
"omittedPlacements",
"placements",
"placementsComplete",
"title",
"width",
"windowId",
"windowName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"complete",
"omittedEntries",
"panes"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false
}
Esc

Type to search.