Python MCP reference

tool MCPstable

`get_session_info`

get_session_info( session_id?: string | null, session_name?: string | null, socket_name?: string | null, )

tool [source]¶

Return metadata for a single tmux session (ID, name, window count, activity).

Use this instead of list_sessions + filter when you only need one session’s info. Resolves by session_id first; falls back to session_name.

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

Arguments#

session_id? = null (string | null) #

Session ID (e.g. ‘$0’).
session_name? = null (string | null) #

Session name.
socket_name? = null (string | null) #

tmux socket name.

No other arguments are accepted.

Result#

Returns object

active_pane_id? = null (string | null) #

Pane id (%N) of the session’s active pane. Guaranteed non-None on create_session return (libtmux creates the session with one initial pane). May be None from list_sessions rows for sessions in transient teardown states where active_pane is unavailable.
session_attached? = null (string | null) #

Attached client count
session_created? = null (string | null) #

Creation timestamp
session_id (string) #

Session ID (e.g. ‘$1’)
session_name? = null (string | null) #

Session name
window_count (integer) #

Number of windows

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": {
    "session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Session ID (e.g. '$0')."
    },
    "session_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Session name."
    },
    "socket_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "tmux socket name."
    }
  },
  "type": "object"
}

Output schema

{
  "description": "Serialized tmux session.",
  "properties": {
    "active_pane_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Pane id (``%N``) of the session's active pane. Guaranteed non-None on ``create_session`` return (libtmux creates the session with one initial pane). May be None from ``list_sessions`` rows for sessions in transient teardown states where ``active_pane`` is unavailable."
    },
    "session_attached": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Attached client count"
    },
    "session_created": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Creation timestamp"
    },
    "session_id": {
      "description": "Session ID (e.g. '$1')",
      "type": "string"
    },
    "session_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Session name"
    },
    "window_count": {
      "description": "Number of windows",
      "type": "integer"
    }
  },
  "required": [
    "session_id",
    "window_count"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

tmux

`get_session_info`

Arguments#

Result#

Annotations#

Protocol data#