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

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

All Go tools · JSON · Source

Arguments

effective optional · boolean
include an inherited value
name required · string
the exact option name
scope optional · string
global, server, session, window, or pane
target optional · string
the target required by session, window, and pane scopes

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"effective": {
"description": "include an inherited value",
"type": "boolean"
},
"name": {
"description": "the exact option name",
"type": "string"
},
"scope": {
"description": "global, server, session, window, or pane",
"enum": [
"",
"global",
"server",
"session",
"window",
"pane"
],
"type": "string"
},
"target": {
"description": "the target required by session, window, and pane scopes",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"inherited": {
"type": "boolean"
},
"name": {
"type": "string"
},
"scope": {
"type": "string"
},
"set": {
"type": "boolean"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"scope",
"value",
"set"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"openWorldHint": true,
"title": "Show one option"
}
Esc

Type to search.