MCPconceptTools

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

tool MCPlatest

show_option

show_option( name: string, scope?: "server" | "session" | "global-session" | "window" | "global-window" | "pane", target?: string, )
tool [source]

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.

MCP request method
tools/call Send show_option as the tool name, with the arguments below.

Arguments#

  • name (string) #

    The tmux option to read, such as “status-left”.

  • scope? ("server" | "session" | "global-session" | "window" | "global-window" | "pane") #

    Default server.

  • target? (string) #

    Session id/name or pane id, for the matching scope.

Result#

Returns object

No other properties are accepted.

Annotations#

destructiveHint
true
idempotentHint
false
openWorldHint
true
readOnlyHint
false

Protocol data#

Use the complete advertised contract for validation and client integration.

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"
}
Esc

Type to search.

Reference previewOpen reference