mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-16 18:49:14 +02:00
95 lines
2.7 KiB
Text
95 lines
2.7 KiB
Text
---
|
|
title: Installation
|
|
icon: arrow-down-to-line
|
|
---
|
|
## Install FastMCP
|
|
|
|
We recommend using [uv](https://docs.astral.sh/uv/getting-started/installation/) to install and manage FastMCP.
|
|
|
|
If you plan to use FastMCP in your project, you can add it as a dependency with:
|
|
|
|
```bash
|
|
uv add fastmcp
|
|
```
|
|
|
|
Alternatively, you can install it directly with `pip` or `uv pip`:
|
|
<CodeGroup>
|
|
```bash uv
|
|
uv pip install fastmcp
|
|
```
|
|
|
|
```bash pip
|
|
pip install fastmcp
|
|
```
|
|
</CodeGroup>
|
|
|
|
### Verify Installation
|
|
|
|
To verify that FastMCP is installed correctly, you can run the following command:
|
|
|
|
```bash
|
|
fastmcp version
|
|
```
|
|
|
|
You should see output like the following:
|
|
|
|
```bash
|
|
$ fastmcp version
|
|
|
|
FastMCP version: 0.4.2.dev41+ga077727.d20250410
|
|
MCP version: 1.6.0
|
|
Python version: 3.12.2
|
|
Platform: macOS-15.3.1-arm64-arm-64bit
|
|
FastMCP root path: ~/Developer/fastmcp
|
|
```
|
|
## Upgrading from the Official MCP SDK
|
|
|
|
Upgrading from the official MCP SDK's FastMCP 1.0 to FastMCP 2.0 is generally straightforward. The core server API is highly compatible, and in many cases, changing your import statement from `from mcp.server.fastmcp import FastMCP` to `from fastmcp import FastMCP` will be sufficient.
|
|
|
|
|
|
```python {1-5}
|
|
# Before
|
|
# from mcp.server.fastmcp import FastMCP
|
|
|
|
# After
|
|
from fastmcp import FastMCP
|
|
|
|
mcp = FastMCP("My MCP Server")
|
|
```
|
|
<Warning>
|
|
Prior to `fastmcp==2.3.0` and `mcp==1.8.0`, the 2.x API always mirrored the 1.0 API. However, as the projects diverge, this can not be guaranteed. You may see deprecation warnings if you attempt to use 1.0 APIs in FastMCP 2.x. Please refer to this documentation for details on new capabilities.
|
|
</Warning>
|
|
|
|
## Installing for Development
|
|
|
|
If you plan to contribute to FastMCP, you should begin by cloning the repository and using uv to install all dependencies (development dependencies are installed automatically):
|
|
|
|
```bash
|
|
git clone https://github.com/jlowin/fastmcp.git
|
|
cd fastmcp
|
|
uv sync
|
|
```
|
|
|
|
This will install all dependencies, including ones for development, and create a virtual environment, which you can activate and use as normal.
|
|
|
|
### Unit Tests
|
|
|
|
FastMCP has a comprehensive unit test suite, and all PR's must introduce and pass appropriate tests. To run the tests, use pytest:
|
|
|
|
```bash
|
|
pytest
|
|
```
|
|
|
|
### Pre-Commit Hooks
|
|
|
|
FastMCP uses pre-commit to manage code quality, including formatting, linting, and type-safety. All PRs must pass the pre-commit hooks, which are run as a part of the CI process. To install the pre-commit hooks, run:
|
|
|
|
```bash
|
|
uv run pre-commit install
|
|
```
|
|
|
|
Alternatively, to run pre-commit manually at any time, use:
|
|
|
|
```bash
|
|
pre-commit run --all-files
|
|
```
|