MCPAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

get_session_info

Inspect tmux metadata; accepts no client-supplied executable input. Return metadata for one session without listing every session.

All TypeScript tools · JSON · Source

Arguments

session required · string
Session id ($1) or name.

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"
}
},
"required": [
"session"
],
"type": "object"
}
Output schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"session": {
"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"
}
},
"required": [
"session"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false
}
Esc

Type to search.