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_tmux_variables

Read configured tmux commands; accepts no client-supplied executable input. Returned values may contain executable configuration. Expand named tmux format variables for a pane, such as session_name or window_width. Use it for fields nothing else answers; get_pane_info already returns the common ones, and show_option reads configuration rather than live state.

All C# tools · JSON · Source

Arguments

names required · array
Variable names such as session_name, without #{...}. Between 1 and 64 names, each at most 64 letters, digits and underscores.
paneId optional · string | null
A pane id used as the lookup context. Omit for this server's own pane, or else the one the first session shows.

Default: null.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"names": {
"description": "Variable names such as session_name, without #{...}. Between 1 and 64 names, each at most 64 letters, digits and underscores.",
"items": {
"type": "string"
},
"type": "array"
},
"paneId": {
"default": null,
"description": "A pane id used as the lookup context. Omit for this server's own pane, or else the one the first session shows.",
"type": [
"string",
"null"
]
}
},
"required": [
"names"
],
"type": "object"
}
Output schema
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Get tmux variables"
}
Esc

Type to search.