# show_option

Source: https://libtmux.org/en/rs/latest/mcp/tools/show_option/

> Read a tmux option, such as history-limit or a user option like @theme. Name the scope the option lives in; global-session is what tmux uses when a command names no target. Read configured tmux commands; accepts no client-supplied executable input. Returned values may contain executable configuration.

MCP is in development

Server behavior and tool contracts may change. Tool availability depends on the server configuration.

Read a tmux option, such as history-limit or a user option like @theme. Name the scope the option lives in; global-session is what tmux uses when a command names no target. Read configured tmux commands; accepts no client-supplied executable input. Returned values may contain executable configuration.

[All Rust tools](https://libtmux.org/en/rs/latest/mcp/tools/) · [JSON](https://libtmux.org/en/rs/latest/mcp/tools/show_option.json) · [Source](https://github.com/libtmux/libtmux-rs/blob/2cef1aa642182dd1970c3688feb6a568ff666e64/crates/tmux-mcp/src/tools/inspect.rs#L457)

## Arguments

* `name` required · string

  The option name, such as \`history-limit\` or a user option like \`@theme\`.

* `scope` optional

  Which tmux object the option belongs to. One of \`server\`, \`global-session\`, \`global-window\`, \`session\`, \`window\`, or \`pane\`. Defaults to \`global-session\`, which is what setting an option without a target means in tmux.

* `target` optional · string | null

  The \`$\`, \`@\` or \`%\`-prefixed id, for the scopes that need one. Omit for the others.

## Schemas

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

Input schema

```json
{
  "$defs": {
    "OptionScopeSchema": {
      "enum": [
        "server",
        "global-session",
        "global-window",
        "session",
        "window",
        "pane"
      ],
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "The option name, such as `history-limit` or a user option like `@theme`.",
      "type": "string"
    },
    "scope": {
      "anyOf": [
        {
          "$ref": "#/$defs/OptionScopeSchema"
        },
        {
          "type": "null"
        }
      ],
      "description": "Which tmux object the option belongs to.\n\nOne of `server`, `global-session`, `global-window`, `session`,\n`window`, or `pane`. Defaults to `global-session`, which is what\nsetting an option without a target means in tmux."
    },
    "target": {
      "description": "The `$`, `@` or `%`-prefixed id, for the scopes that need one. Omit\nfor the others.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
```

Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "description": "The option name.",
      "type": "string"
    },
    "value": {
      "description": "Its value, absent when it has never been set at that scope.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
```

Tool annotations

```json
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": true,
  "title": "Read tmux Option"
}
```