# WelcomeBanner

> **Class** in `deepagents_code`

📖 [View in docs](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner)

Compact welcome banner shown at startup.

Renders a bordered box with the product title and optional version. A
`(debug enabled)` tag appears when `DEEPAGENTS_CODE_DEBUG` is enabled
(truthy), and an `(experimental mode)` tag appears when
`DEEPAGENTS_CODE_EXPERIMENTAL` is enabled (truthy), both even when the
version is hidden. A `(local)` tag appears for
editable installs only when the version is shown. Rows follow that appear
only when their data (and any env gate) is present. In render order: the
active model
(`SPLASH_SHOW_MODEL`, opt-in), working directory (`SPLASH_SHOW_CWD`,
opt-in), LangSmith tracing project and its replica (each clickable once its
URL resolves), thread ID (debug mode only), and the MCP tool count. MCP
server warnings and the editable-install path follow.

## Signature

```python
WelcomeBanner(
    self,
    thread_id: str | None = None,
    mcp_tool_count: int = 0,
    *,
    model_provider: str = '',
    model_name: str = '',
    cwd: str | None = None,
    mcp_unauthenticated: int = 0,
    mcp_errored: int = 0,
    mcp_awaiting_reconnect: int = 0,
    **kwargs: Any = {},
)
```

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `thread_id` | `str \| None` | No | Displayed only when debug mode is enabled. (default: `None`) |
| `mcp_tool_count` | `int` | No | Number of MCP tools loaded at startup. (default: `0`) |
| `model_provider` | `str` | No | Active model provider (e.g. `anthropic`). Displayed only when `SPLASH_SHOW_MODEL` is enabled. (default: `''`) |
| `model_name` | `str` | No | Active model name. Displayed only when `SPLASH_SHOW_MODEL` is enabled. (default: `''`) |
| `cwd` | `str \| None` | No | Working directory. Defaults to the process cwd. Displayed only when `SPLASH_SHOW_CWD` is enabled. (default: `None`) |
| `mcp_unauthenticated` | `int` | No | Number of MCP servers awaiting login. (default: `0`) |
| `mcp_errored` | `int` | No | Number of MCP servers that failed to load. (default: `0`) |
| `mcp_awaiting_reconnect` | `int` | No | Number of MCP servers awaiting reconnect. (default: `0`) |
| `**kwargs` | `Any` | No | Additional arguments passed to parent. (default: `{}`) |

## Extends

- `Static`

## Constructors

```python
__init__(
    self,
    thread_id: str | None = None,
    mcp_tool_count: int = 0,
    *,
    model_provider: str = '',
    model_name: str = '',
    cwd: str | None = None,
    mcp_unauthenticated: int = 0,
    mcp_errored: int = 0,
    mcp_awaiting_reconnect: int = 0,
    **kwargs: Any = {},
) -> None
```

| Name | Type |
|------|------|
| `thread_id` | `str \| None` |
| `mcp_tool_count` | `int` |
| `model_provider` | `str` |
| `model_name` | `str` |
| `cwd` | `str \| None` |
| `mcp_unauthenticated` | `int` |
| `mcp_errored` | `int` |
| `mcp_awaiting_reconnect` | `int` |


## Properties

- `auto_links`
- `DEFAULT_CSS`

## Methods

- [`on_mount()`](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner/on_mount)
- [`update_model()`](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner/update_model)
- [`update_cwd()`](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner/update_cwd)
- [`update_thread_id()`](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner/update_thread_id)
- [`set_connected()`](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner/set_connected)
- [`on_click()`](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner/on_click)
- [`on_mouse_move()`](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner/on_mouse_move)
- [`on_leave()`](https://reference.langchain.com/python/deepagents-code/tui/widgets/welcome/WelcomeBanner/on_leave)

---

[View source on GitHub](https://github.com/langchain-ai/deepagents/blob/7794b61a6e76230e8c7a49bdce808b3728305914/libs/code/deepagents_code/tui/widgets/welcome.py#L160)