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 a bounded set of tmux variables against one pane. tmux reads a name it does not know as a format from its environment, so a name the server or session environment holds is refused unless the operator listed it in LIBTMUX_ENVIRONMENT_VALUES at startup. Read configured tmux commands; accepts no client-supplied executable input. Returned values may contain executable configuration.

All Rust tools · JSON · Source

Arguments

names required · array
tmux format variable names, such as `pane_current_path`.
pane optional · string | null
The `%`-prefixed pane to read them against. Omit to let tmux pick its current pane.

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": {
"names": {
"description": "tmux format variable names, such as `pane_current_path`.",
"items": {
"pattern": "^[A-Za-z][A-Za-z0-9_]*$",
"type": "string"
},
"maxItems": 32,
"minItems": 1,
"type": "array"
},
"pane": {
"description": "The `%`-prefixed pane to read them against. Omit to let tmux pick\nits current pane.",
"type": [
"string",
"null"
]
}
},
"required": [
"names"
],
"type": "object"
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"values": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"values"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true,
"title": "Get tmux Variables"
}
Esc

Type to search.