WelcomeBanner

WelcomeBanner(
  self,
  thread_id: str | None = None,
  mcp_tool_count: int = 0

Bases

Static

Constructors

Attributes

Methods

View source on GitHub

defer_connecting_display

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.
`mcp_unauthenticated`	`int`	Default:`0` Number of MCP servers awaiting login.
`mcp_errored`	`int`	Default:`0`
`connecting`	`bool`	Default:`False`
`resuming`	`bool`	Default:`False`
`local_server`	`bool`	Default:`False`
`defer_connecting_display`	`bool`	Default:`False`
`**kwargs`	`Any`	Default:`{}`

constructor

__init__

Name	Type
thread_id	str \| None
mcp_tool_count	int
mcp_unauthenticated	int
mcp_errored	int
connecting	bool
resuming	bool
local_server	bool
defer_connecting_display	bool

Welcome banner displayed at startup.

Number of MCP servers that failed to load.

When True, show a "Connecting..." footer instead of the normal ready prompt. Call set_connected to transition.

When True, the connecting footer says "Resuming..." instead of any 'Connecting...' variant.

When True, the connecting footer qualifies the server as "local" (i.e. a server process).

Ignored when resuming is True.

When True and connecting is True, suppress the connecting footer initially so a fast startup feels instantaneous; the welcome footer remains visible until startup resolves. The connecting footer is revealed by reveal_connecting_footer (called when the user submits a message during startup) or automatically after _CONNECTING_FOOTER_DELAY_SECONDS.

Additional arguments passed to parent.