list_sessions

Rust

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

List every tmux session on the server. Inspect tmux metadata; accepts no client-supplied executable input.

All Rust tools · JSON · Source

Arguments

This tool has no top-level named arguments. Consult its schema below.

Schemas

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

Input schema

{
  "additionalProperties": false,
  "properties": {},
  "type": "object"
}

Output schema

{
  "$defs": {
    "SessionView": {
      "description": "One session, as the protocol sees it.",
      "properties": {
        "attached": {
          "description": "Whether any client is attached.",
          "type": "boolean"
        },
        "id": {
          "description": "The `$`-prefixed tmux identity.",
          "type": "string"
        },
        "name": {
          "description": "The session name, absent when tmux reported none.",
          "type": "string"
        },
        "windows": {
          "description": "How many windows the session holds.",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "id",
        "name",
        "windows",
        "attached"
      ],
      "type": "object"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sessions": {
      "description": "The sessions, in tmux's own order.",
      "items": {
        "$ref": "#/$defs/SessionView"
      },
      "type": "array"
    }
  },
  "required": [
    "sessions"
  ],
  "type": "object"
}

Tool annotations

{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": true,
  "title": "List Sessions"
}