Python MCP reference

tool MCPstable

`get_server_info`

get_server_info( socket_name?: string | null, )

tool [source]¶

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.

MCP request method: tools/call Send get_server_info as the tool name, with the arguments below.

Arguments#

socket_name? = null (string | null) #

tmux socket name. Defaults to LIBTMUX_SOCKET env var.

No other arguments are accepted.

Result#

Returns object

is_alive (boolean) #

Whether the server is running
session_count (integer) #

Number of sessions
socket_name? = null (string | null) #

Socket name
socket_path? = null (string | null) #

Socket path
version? = null (string | null) #

tmux version

Annotations#

destructiveHint: true
idempotentHint: false
openWorldHint: true
readOnlyHint: false

Protocol data#

Use the complete advertised contract for validation and client integration.

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"
}

Scripting & web

Compiled & native

JVM

.NET

tmux

`get_server_info`

Arguments#

Result#

Annotations#

Protocol data#