diff --git a/docs/assets/brand/f-watercolor-waves-2.png b/docs/assets/brand/f-watercolor-waves-2.png index 56c712c667..3dc9951ee3 100644 Binary files a/docs/assets/brand/f-watercolor-waves-2.png and b/docs/assets/brand/f-watercolor-waves-2.png differ diff --git a/docs/assets/brand/f-watercolor-waves-dark-2.jpeg b/docs/assets/brand/f-watercolor-waves-dark-2.jpeg index b465842ca9..ec3d1406c4 100644 Binary files a/docs/assets/brand/f-watercolor-waves-dark-2.jpeg and b/docs/assets/brand/f-watercolor-waves-dark-2.jpeg differ diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx index 78ef9db43a..32e8ca951a 100644 --- a/docs/getting-started/installation.mdx +++ b/docs/getting-started/installation.mdx @@ -6,30 +6,33 @@ icon: arrow-down-to-line We recommend using [uv](https://docs.astral.sh/uv/getting-started/installation/) to install and manage FastMCP. + +FastMCP 3.0 is currently in beta. You must explicitly opt in to pre-release versions using the flags shown below. + + If you plan to use FastMCP in your project, you can add it as a dependency with: ```bash -uv add fastmcp +uv add fastmcp --prerelease=allow ``` Alternatively, you can install it directly with `pip` or `uv pip`: ```bash uv - uv pip install fastmcp + uv pip install fastmcp --prerelease=allow ``` ```bash pip - pip install fastmcp + pip install fastmcp --pre ``` ### Optional Dependencies -FastMCP provides optional extras for specific features: +FastMCP provides optional extras for specific features. For example, to install the background tasks extra: ```bash -# Background tasks (Docket-based distributed task scheduling) -pip install "fastmcp[tasks]" +pip install "fastmcp[tasks]" --pre ``` See [Background Tasks](/servers/tasks) for details on the task system. diff --git a/docs/servers/tasks.mdx b/docs/servers/tasks.mdx index dbc1725d45..f5130bbc64 100644 --- a/docs/servers/tasks.mdx +++ b/docs/servers/tasks.mdx @@ -10,6 +10,10 @@ import { VersionBadge } from "/snippets/version-badge.mdx" + +Background tasks require the `tasks` optional extra. See [installation instructions](#enabling-background-tasks) below. + + FastMCP implements the MCP background task protocol ([SEP-1686](https://modelcontextprotocol.io/specification/2025-11-25/basic/utilities/tasks)), giving your servers a production-ready distributed task scheduler with a single decorator change. @@ -39,9 +43,9 @@ MCP background tasks are different: they're **protocol-native**. This means MCP Background tasks require the `tasks` extra: ```bash -pip install "fastmcp[tasks]" +pip install "fastmcp[tasks]" --pre # or with uv -uv add "fastmcp[tasks]" +uv add "fastmcp[tasks]" --prerelease=allow ``` Add `task=True` to any tool, resource, resource template, or prompt decorator. This marks the component as capable of background execution.