Python MCP reference

tool MCPstable

`list_sessions`

list_sessions( filters?: Record<string, string> | string | null, socket_name?: string | null, )

tool [source]¶

List tmux sessions (terminal workspaces) on a tmux server.

Use for tmux multiplexer sessions — ‘this session’, ‘my workspace’, ‘the dev session’ — not login sessions or HTTP sessions. The starting point for discovery — call this before targeting specific sessions, windows, or panes.

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

Arguments#

filters? = null (Record<string, string> | string | null) #

Django-style filters as a dict (e.g. {"session_name__contains": "dev"}) or as a JSON string. Some MCP clients require the string form.
socket_name? = null (string | null) #

tmux socket name. Defaults to LIBTMUX_SOCKET env var.

No other arguments are accepted.

Result#

Returns object

result (Array<object>) #
- Items (object) #
  
  Serialized tmux session.
  - 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": {
    "filters": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Django-style filters as a dict (e.g. ``{\"session_name__contains\": \"dev\"}``)\nor as a JSON string. Some MCP clients require the string form."
    },
    "socket_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "tmux socket name. Defaults to LIBTMUX_SOCKET env var."
    }
  },
  "type": "object"
}

Output schema

{
  "properties": {
    "result": {
      "items": {
        "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"
      },
      "type": "array"
    }
  },
  "required": [
    "result"
  ],
  "type": "object",
  "x-fastmcp-wrap-result": true
}

Scripting & web

Compiled & native

JVM

.NET

tmux

`list_sessions`

Arguments#

Result#

Annotations#

Protocol data#