# set_mouse_enabled

Source: https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/

> Change tmux state; no client-supplied executable input. Set the global tmux mouse option through a closed boolean schema.

tool MCPlatest

MCP concept example

A working example of the core library. It can change without notice.

[What concept means](https://libtmux.org/en/meta/support/#concept-and-alpha)

* **set_mouse_enabled**( [enabled](https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/#mcp.tool.set_mouse_enabled.input%2Fproperties%2Fenabled): [boolean](https://json-schema.org/understanding-json-schema/reference/boolean "boolean (JSON Schema)"), )

  tool \[[source](https://github.com/libtmux/libtmux-ts/blob/46cccfef2a546de55ce8b308249b8c76339089a0/packages/mcp/src/tools/target.ts#L404)][¶](https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/#mcp.tool.set_mouse_enabled)

  Change tmux state; no client-supplied executable input. Set the global tmux mouse option through a closed boolean schema.

  * MCP request method

    `tools/call` Send `set_mouse_enabled` as the tool name, with the arguments below.

  ## Arguments[#](https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/#mcp.tool.set_mouse_enabled.parameters)

  * **[`enabled`](https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/#mcp.tool.set_mouse_enabled.input%2Fproperties%2Fenabled)** ([boolean](https://json-schema.org/understanding-json-schema/reference/boolean "boolean (JSON Schema)"))

    Whether tmux should report mouse events.

  ## Result[#](https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/#mcp.tool.set_mouse_enabled.result)

  Returns [object](https://json-schema.org/understanding-json-schema/reference/object "object (JSON Schema)")

  * **[`enabled`](https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/#mcp.tool.set_mouse_enabled.output%2Fproperties%2Fenabled)** ([boolean](https://json-schema.org/understanding-json-schema/reference/boolean "boolean (JSON Schema)"))

  No other properties are accepted.

  ## Annotations[#](https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/#mcp.tool.set_mouse_enabled.annotations)

  * [`destructiveHint`](https://libtmux.org/en/ts/latest/mcp/reference/glossary/#destructiveHint)

    `true`

  * [`idempotentHint`](https://libtmux.org/en/ts/latest/mcp/reference/glossary/#idempotentHint)

    `false`

  * [`openWorldHint`](https://libtmux.org/en/ts/latest/mcp/reference/glossary/#openWorldHint)

    `true`

  * [`readOnlyHint`](https://libtmux.org/en/ts/latest/mcp/reference/glossary/#readOnlyHint)

    `false`

  ## Protocol data[#](https://libtmux.org/en/ts/latest/mcp/tools/set_mouse_enabled/#mcp.tool.set_mouse_enabled.schemas)

  Use the complete advertised contract for validation and client integration.

  Input schema

  ```json
  {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "properties": {
      "enabled": {
        "description": "Whether tmux should report mouse events.",
        "type": "boolean"
      }
    },
    "required": [
      "enabled"
    ],
    "type": "object"
  }
  ```

  Output schema

  ```json
  {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "additionalProperties": false,
    "properties": {
      "enabled": {
        "type": "boolean"
      }
    },
    "required": [
      "enabled"
    ],
    "type": "object"
  }
  ```