get_server_info

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript
Rust
Go
Java
.NET
C++
Swift

Get information about the tmux server.

Use to verify the tmux server is running before other operations. For session-level details, use list_sessions instead.

All Python tools · JSON · Source

Arguments

socket_name optional: tmux socket name. Defaults to LIBTMUX_SOCKET env var.
Default: null.

Schemas

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

Input schema

{
  "additionalProperties": false,
  "properties": {
    "socket_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "tmux socket name. Defaults to LIBTMUX_SOCKET env var."
    }
  },
  "type": "object"
}

Output schema

{
  "description": "Serialized tmux server info.",
  "properties": {
    "is_alive": {
      "description": "Whether the server is running",
      "type": "boolean"
    },
    "session_count": {
      "description": "Number of sessions",
      "type": "integer"
    },
    "socket_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Socket name"
    },
    "socket_path": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Socket path"
    },
    "version": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "tmux version"
    }
  },
  "required": [
    "is_alive",
    "session_count"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false
}