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

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

All Rust tools · JSON · Source

Arguments

session required · string
The session, by `$`-prefixed id as `list_sessions` reports it, or by name.

Schemas

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

Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"session": {
"description": "The session, by `$`-prefixed id as `list_sessions` reports it, or by\nname.",
"type": "string"
}
},
"required": [
"session"
],
"type": "object"
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"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"
}
Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true,
"title": "Get Session Info"
}
Esc

Type to search.