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.

set_mouse_enabled

Set mouse handling for a session or the global session default. Change tmux state; no client-supplied executable input.

All Rust tools · JSON · Source

Arguments

enabled required · boolean
`true` turns mouse handling on; `false` turns it off.
session optional · string | null
The session to change, by `$`-prefixed id or name. Omit to change the global default.

Schemas

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

Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "`true` turns mouse handling on; `false` turns it off.",
"type": "boolean"
},
"session": {
"description": "The session to change, by `$`-prefixed id or name. Omit to change the\nglobal default.",
"type": [
"string",
"null"
]
}
},
"required": [
"enabled"
],
"type": "object"
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string"
},
"target": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": false,
"title": "Set Mouse Enabled"
}
Esc

Type to search.