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. Read one named tmux option at server, session, window, or pane scope.

All TypeScript tools · JSON · Source

Arguments

name required · string
The tmux option to read, such as "status-left".
scope optional · string
Default server.
target optional · string
Session id/name or pane id, for the matching scope.

Schemas

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

Input schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"description": "The tmux option to read, such as \"status-left\".",
"type": "string"
},
"scope": {
"description": "Default server.",
"enum": [
"server",
"session",
"global-session",
"window",
"global-window",
"pane"
],
"type": "string"
},
"target": {
"description": "Session id/name or pane id, for the matching scope.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Output schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"scope": {
"type": "string"
},
"value": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"scope",
"value"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false
}
Esc

Type to search.