worktree/list

Experimental

Lists the worktrees of the repository at workspaceRoot: each checkout’s path, branch (omitted when detached, bare, or Sapling), main-checkout flag, and live session ids, so apps can warn on sharing.

Parameters

Type: WorktreeListParams

worktree/list params: any in-repo path — the main checkout, a linked checkout, or a subdirectory spelling — which the host canonicalizes and resolves to its repository before listing.

Field	Type	Stability	Presence	Description
workspaceRoot	string	Experimental	required	The path to resolve to a repository and list.

Source

schema/msp/experimental/msp.schema.json#/methods/worktree~2Flist

{
  "description": "Lists the worktrees of the repository at `workspaceRoot`: each checkout's path, branch (omitted when detached, bare, or Sapling), main-checkout flag, and live session ids, so apps can warn on sharing.",
  "params": {
    "$ref": "#/$defs/WorktreeListParams"
  },
  "result": {
    "$ref": "#/$defs/WorktreeListResult"
  },
  "x-msp-descriptor": "worktree/list",
  "x-msp-stability": "experimental"
}