Function configure_mcp_server

dash/mcp/_configure.py:45–133

Configure which content the Dash MCP server exposes. Only the parameters that are explicitly passed are updated; any parameter that is omitted keeps its current value. On the first call, unset values take their defaults (all content included except callback docstrings). :param

(
    *,
    include_layout: Optional[bool] = None,
    include_callbacks: Optional[bool] = None,
    include_clientside_callbacks: Optional[bool] = None,
    include_pages: Optional[bool] = None,
    expose_callback_docstrings: Optional[bool] = None,
)

def configure_mcp_server(
    *,
    include_layout: Optional[bool] = None,
    include_callbacks: Optional[bool] = None,
    include_clientside_callbacks: Optional[bool] = None,
    include_pages: Optional[bool] = None,
    expose_callback_docstrings: Optional[bool] = None,
) -> None:
    """
    Configure which content the Dash MCP server exposes.

    Only the parameters that are explicitly passed are updated; any parameter
    that is omitted keeps its current value. On the first call, unset values
    take their defaults (all content included except callback docstrings).

    :param include_layout: Expose ``dash://layout``, ``dash://components``,
        and the ``get_dash_component`` tool.  Defaults to ``True``.
    :param include_callbacks: When ``True`` (default), all callbacks are
        included; ``mcp_enabled=False`` on a ``@callback`` opts it out.
        When ``False``, no callbacks are included by default;
        ``mcp_enabled=True`` opts a specific callback in.
    :param include_clientside_callbacks: Expose the
        ``dash://clientside-callbacks`` resource.  Defaults to ``True``.
    :param include_pages: Expose ``dash://pages`` and
        ``dash://page-layout/{path}``.  Defaults to ``True``.
    :param expose_callback_docstrings: Include callback docstrings in
        tool descriptions.  Defaults to ``False``.

    Example — expose only ``@mcp_enabled``-decorated functions::

        from dash.mcp import configure_mcp_server

        configure_mcp_server(
            include_layout=False,
            include_callbacks=False,
            include_clientside_callbacks=False,
            include_pages=False,
        )
    """
    try:
        if get_app().backend.has_request_context():
            raise RuntimeError("MCP server can't be configured within a callback")
    except AppNotFoundError:
        pass

    passed = {
        "include_layout": include_layout,
        "include_callbacks": include_callbacks,
        "include_clientside_callbacks": include_clientside_callbacks,
        "include_pages": include_pages,
        "expose_callback_docstrings": expose_callback_docstrings,
    }
    _current_config.update(
        {key: value for key, value in passed.items() if value is not None}
    )

    CallbackTools.callbacks_mcp_enabled_by_default = _current_config[
        "include_callbacks"