# set_mouse_enabled

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

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

MCP is in development

Server behavior and tool contracts may change. Tool availability depends on the server configuration.

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

[All Rust tools](https://libtmux.org/en/rs/latest/mcp/tools/) · [JSON](https://libtmux.org/en/rs/latest/mcp/tools/set_mouse_enabled.json) · [Source](https://github.com/libtmux/libtmux-rs/blob/2cef1aa642182dd1970c3688feb6a568ff666e64/crates/tmux-mcp/src/tools/contract.rs#L864)

## 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

```json
{
  "$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

```json
{
  "$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

```json
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": false,
  "title": "Set Mouse Enabled"
}
```