Auto Light Dark

MCPAPI Reference

Choose documentation 3

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Browse documentation

MCPAPI Reference

On this page

set_mouse_enabled

Enables or disables tmux mouse handling. Change tmux state; no client-supplied executable input.

All Java tools · JSON · Source

Arguments

enabled optional · boolean: Whether mouse handling is enabled. Defaults to false.
Default: false.

Schemas

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

Input schema

{
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "default": false,
      "description": "Whether mouse handling is enabled. Defaults to false.",
      "type": "boolean"
    }
  },
  "required": [],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false,
  "title": "Set mouse handling"
}