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 tmux options at the server, session, window or pane level. Values set at a wider scope are included and marked inherited, because that is where nearly all tmux configuration lives. Omit the name to list them all. Reading history-limit before a long tail tells you how much output the pane can hold before it starts dropping lines.

All C# tools · JSON · Source

Arguments

name required · string
The option name.
paneId optional · string | null
The pane whose scope is read. Omit for this server's own pane, or else the one the first session shows.

Default: null.

scope optional · string
Server, Session, Window, or Pane.

Default: "Pane".

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"name": {
"description": "The option name.",
"type": "string"
},
"paneId": {
"default": null,
"description": "The pane whose scope is read. Omit for this server's own pane, or else the one the first session shows.",
"type": [
"string",
"null"
]
},
"scope": {
"default": "Pane",
"description": "Server, Session, Window, or Pane.",
"enum": [
"Server",
"Session",
"Window",
"Pane"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Output schema
{
"properties": {
"result": {
"items": {
"properties": {
"inherited": {
"type": "boolean"
},
"name": {
"type": "string"
},
"scope": {
"enum": [
"Server",
"Session",
"Window",
"Pane"
],
"type": "string"
},
"value": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"value",
"scope",
"inherited"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Show option"
}
Esc

Type to search.