mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-28 02:10:38 +02:00
Clarify installation for FastMCP 3.0 beta (#2953)
This commit is contained in:
parent
3df38584cf
commit
c14ef132da
4 changed files with 15 additions and 8 deletions
Binary file not shown.
|
Before Width: | Height: | Size: 1.5 MiB After Width: | Height: | Size: 815 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 662 KiB After Width: | Height: | Size: 667 KiB |
|
|
@ -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.
|
||||
|
||||
<Note>
|
||||
FastMCP 3.0 is currently in beta. You must explicitly opt in to pre-release versions using the flags shown below.
|
||||
</Note>
|
||||
|
||||
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`:
|
||||
<CodeGroup>
|
||||
```bash uv
|
||||
uv pip install fastmcp
|
||||
uv pip install fastmcp --prerelease=allow
|
||||
```
|
||||
|
||||
```bash pip
|
||||
pip install fastmcp
|
||||
pip install fastmcp --pre
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### 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.
|
||||
|
|
|
|||
|
|
@ -10,6 +10,10 @@ import { VersionBadge } from "/snippets/version-badge.mdx"
|
|||
|
||||
<VersionBadge version="2.14.0" />
|
||||
|
||||
<Tip>
|
||||
Background tasks require the `tasks` optional extra. See [installation instructions](#enabling-background-tasks) below.
|
||||
</Tip>
|
||||
|
||||
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.
|
||||
|
||||
<Tip>
|
||||
|
|
@ -39,9 +43,9 @@ MCP background tasks are different: they're **protocol-native**. This means MCP
|
|||
<VersionBadge version="3.0.0" /> 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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue