Class●Since v0.0

WelcomeBanner

Welcome banner displayed at startup.

WelcomeBanner(
  self,
  thread_id: str | None = None,
  mcp_tool_count: int = 0,
  *,
  connecting: bool = False,
  resuming: bool = False,
  local_server: bool = False,
  **kwargs: Any = {}
)

Bases

Static

Parameters

Name	Type	Description
`thread_id`	`str \| None`	Default:`None` Optional thread ID to display in the banner.
`mcp_tool_count`	`int`	Default:`0` Number of MCP tools loaded at startup.
`connecting`	`bool`	Default:`False` When `True`, show a "Connecting..." footer instead of the normal ready prompt. Call `set_connected` to transition.
`resuming`	`bool`	Default:`False` When `True`, the connecting footer says "Resuming..." instead of any `'Connecting...'` variant.
`local_server`	`bool`	Default:`False` When `True`, the connecting footer qualifies the server as "local" (i.e. a server process managed by the CLI). Ignored when `resuming` is `True`.
`**kwargs`	`Any`	Default:`{}` Additional arguments passed to parent.