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.

show_option

Reads one named tmux option. Read configured tmux commands; accepts no client-supplied executable input. Returned values may contain executable configuration.

All Java tools · JSON · Source

Arguments

effective optional · boolean
Include an inherited value. Defaults to true.

Default: true.

name required · string
The exact option name.
scope optional · string
global, server, session, window or pane.
target optional · string
Required for session scope (an ID such as $1, or a name), window scope (@1) and pane scope (%1).

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"effective": {
"default": true,
"description": "Include an inherited value. Defaults to true.",
"type": "boolean"
},
"name": {
"description": "The exact option name.",
"type": "string"
},
"scope": {
"description": "global, server, session, window or pane.",
"type": "string"
},
"target": {
"description": "Required for session scope (an ID such as $1, or a name), window scope (@1) and pane scope (%1).",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"scope": {
"type": "string"
},
"target": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"scope",
"target",
"name",
"value"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Show one option"
}
Esc

Type to search.