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

Change tmux state; no client-supplied executable input. Turn tmux mouse support on or off. This sets the global option, so it applies to every session on this server and changes what a human watching can do with their mouse.

All C# tools · JSON · Source

Arguments

enabled required · boolean
Whether mouse support is enabled globally.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Whether mouse support is enabled globally.",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
Output schema
{
"properties": {
"changed": {
"type": "string"
},
"paneId": {
"default": null,
"type": [
"string",
"null"
]
},
"sessionId": {
"default": null,
"type": [
"string",
"null"
]
},
"windowId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"changed"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Set mouse enabled"
}
Esc

Type to search.