MCPconceptAPI Reference

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.

mcp.src.TmuxTools.show_option

#[tool_router(router = inspect_router, vis = "pub(super)")] impl TmuxTools #[tool( description = "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.", title = "Read tmux Option", meta = crate::capability_meta!( Inspect, None, effects = [Observe], outputs = [TmuxMetadata, ConfiguredCommand], secrets = true, untrusted = true, sinks = { "name" => [TmuxLookup, TmuxFormat], "scope" => [None], "target" => [TmuxLookup] }, literalized = ["name"], nested = [], self_bounded = false, always_load = false, ) )] pub async fn show_option( &self, Parameters(OptionArgs { name, scope, target, .. }): Parameters<OptionArgs>, ) -> Result<Json<OptionValue>, ToolError>

Read a tmux option.

Esc

Type to search.

Reference previewOpen reference