MCPpre-alphaTools

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

tool MCPstable

show_option

show_option( global_?: boolean, option: string, scope?: "server" | "session" | "window" | "pane" | null, socket_name?: string | null, target?: string | null, )
tool [source]

Show a tmux option value.

Use to check tmux configuration values such as history-limit, mouse support, or status bar settings.

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

Arguments#

  • global_? = false (boolean) #

    Whether to query the global option.

  • option (string) #

    The tmux option name to query.

  • scope? = null ("server" | "session" | "window" | "pane" | null) #

    Option scope.

  • socket_name? = null (string | null) #

    tmux socket name.

  • target? = null (string | null) #

    Target identifier. For session scope: session name (e.g. ‘mysession’). For window scope: window ID (e.g. ‘@1’). For pane scope: pane ID (e.g. ‘%1’). Requires scope.

No other arguments are accepted.

Result#

Returns object

Annotations#

destructiveHint
true
idempotentHint
false
openWorldHint
true
readOnlyHint
false

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema
{
"additionalProperties": false,
"properties": {
"global_": {
"default": false,
"description": "Whether to query the global option.",
"type": "boolean"
},
"option": {
"description": "The tmux option name to query.",
"type": "string"
},
"scope": {
"anyOf": [
{
"enum": [
"server",
"session",
"window",
"pane"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Option scope."
},
"socket_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "tmux socket name."
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Target identifier. For session scope: session name\n(e.g. 'mysession'). For window scope: window ID (e.g. '@1').\nFor pane scope: pane ID (e.g. '%1'). Requires scope."
}
},
"required": [
"option"
],
"type": "object"
}
Output schema
{
"description": "Result of a show_option call.",
"properties": {
"option": {
"description": "Option name",
"type": "string"
},
"value": {
"description": "Option value"
}
},
"required": [
"option",
"value"
],
"type": "object"
}
Esc

Type to search.

Reference preview Open reference