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]

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

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

Arguments#

No named arguments.

Result#

Returns object

Types#

SessionView: object

type

One session, as the protocol sees it.

Annotations#

destructiveHint
false
idempotentHint
true
openWorldHint
false
readOnlyHint
true
title
"List Sessions"

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema
{
"additionalProperties": false,
"properties": {},
"type": "object"
}
Output schema
{
"$defs": {
"SessionView": {
"description": "One session, as the protocol sees it.",
"properties": {
"attached": {
"description": "Whether any client is attached.",
"type": "boolean"
},
"id": {
"description": "The `$`-prefixed tmux identity.",
"type": "string"
},
"name": {
"description": "The session name, absent when tmux reported none.",
"type": "string"
},
"windows": {
"description": "How many windows the session holds.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"id",
"name",
"windows",
"attached"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sessions": {
"description": "The sessions, in tmux's own order.",
"items": {
"$ref": "#/$defs/SessionView"
},
"type": "array"
}
},
"required": [
"sessions"
],
"type": "object"
}
Esc

Type to search.

Reference previewOpen reference