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

get_server_info

get_server_info()
tool [source]

Report every session with its windows and panes, in one call. Prefer this over calling the three listing tools separately: it costs tmux four commands rather than one per object. Inspect tmux metadata; accepts no client-supplied executable input.

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

Arguments#

No named arguments.

Result#

Returns object

Types#

Branch: object

type

One session with everything under it.

BranchPane: object

type

One pane inside a described window.

BranchWindow: object

type

One window inside a described session.

Annotations#

destructiveHint
false
idempotentHint
true
openWorldHint
false
readOnlyHint
true
title
"Describe Server"

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema
{
"additionalProperties": false,
"properties": {},
"type": "object"
}
Output schema
{
"$defs": {
"Branch": {
"description": "One session with everything under it.",
"properties": {
"attached": {
"description": "Whether any client is attached.",
"type": "boolean"
},
"id": {
"description": "The `$`-prefixed tmux identity.",
"type": "string"
},
"name": {
"description": "The session name.",
"type": "string"
},
"windows": {
"description": "The windows it holds.",
"items": {
"$ref": "#/$defs/BranchWindow"
},
"type": "array"
}
},
"required": [
"id",
"name",
"attached",
"windows"
],
"type": "object"
},
"BranchPane": {
"description": "One pane inside a described window.",
"properties": {
"active": {
"description": "Whether this is the window's active pane.",
"type": "boolean"
},
"command": {
"description": "The command currently running.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The `%`-prefixed tmux identity.",
"type": "string"
}
},
"required": [
"id",
"command",
"active"
],
"type": "object"
},
"BranchWindow": {
"description": "One window inside a described session.",
"properties": {
"active": {
"description": "Whether this is the session's active window.",
"type": "boolean"
},
"id": {
"description": "The `@`-prefixed tmux identity.",
"type": "string"
},
"index": {
"description": "The window's index within its session.",
"format": "int32",
"type": "integer"
},
"linked": {
"description": "Whether more than one session links this window.",
"type": "boolean"
},
"name": {
"description": "The window name.",
"type": "string"
},
"panes": {
"description": "The panes it holds.",
"items": {
"$ref": "#/$defs/BranchPane"
},
"type": "array"
}
},
"required": [
"id",
"index",
"name",
"active",
"linked",
"panes"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sessions": {
"description": "Every session, with its windows and their panes.",
"items": {
"$ref": "#/$defs/Branch"
},
"type": "array"
}
},
"required": [
"sessions"
],
"type": "object"
}
Esc

Type to search.

Reference previewOpen reference