MCPconceptTools

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

tool MCPlatest

list_sessions

list_sessions()
tool [source]

Inspect tmux metadata; accepts no client-supplied executable input. Every session on this server with its id, name, window count, and whether anyone is attached. Metadata only — for what a pane shows, use capture_pane or search_panes.

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

Arguments#

No named arguments.

Result#

Returns object

No other properties are accepted.

Annotations#

destructiveHint
true
idempotentHint
false
openWorldHint
true
readOnlyHint
false

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"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"
},
"sessions": {
"items": {
"additionalProperties": false,
"properties": {
"attachedClients": {
"description": "Raw client count from tmux; 0 means detached. Includes control-mode clients - this server's own wait_for_text or other live read holds one open while it runs, and another program on this socket may hold others. See humanAttachedClients for a person-only count.",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"humanAttachedClients": {
"description": "attachedClients minus every control-mode client, this server's own included.",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"id": {
"description": "Stable session id, e.g. $1.",
"pattern": "^\\$\\d+$",
"type": "string"
},
"metadataComplete": {
"description": "Whether the session name is complete.",
"type": "boolean"
},
"name": {
"type": "string"
},
"omittedMetadataBytes": {
"description": "UTF-8 bytes omitted from the session name.",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"windows": {
"description": "How many windows it holds.",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
}
},
"required": [
"attachedClients",
"humanAttachedClients",
"id",
"metadataComplete",
"name",
"omittedMetadataBytes",
"windows"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"complete",
"omittedEntries",
"sessions"
],
"type": "object"
}
Esc

Type to search.

Reference previewOpen reference