mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-18 11:39:12 +02:00
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Jeremiah Lowin <jlowin@users.noreply.github.com> Co-authored-by: Marvin Context Protocol <41898282+Marvin Context Protocol@users.noreply.github.com> Co-authored-by: voidborne-d <voidborne-d@users.noreply.github.com> Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: d 🔹 <258577966+voidborne-d@users.noreply.github.com> Co-authored-by: Jeremiah Lowin <153965+jlowin@users.noreply.github.com> Co-authored-by: nightcityblade <nightcityblade@gmail.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Bill Easton <strawgate@users.noreply.github.com> Co-authored-by: Sumanshu Nankana <sumanshunankana@gmail.com> Co-authored-by: Eric Robinson <ericrobinson@indeed.com> Co-authored-by: Martim Santos <martimfasantos@gmail.com> Co-authored-by: d 🔹 <liusway405@gmail.com> Co-authored-by: Matthieu B <66959271+mtthidoteu@users.noreply.github.com> Co-authored-by: Sascha Buehrle <47737812+saschabuehrle@users.noreply.github.com> Co-authored-by: Hakancan <142545736+hkc5@users.noreply.github.com> Co-authored-by: nightcityblade <jackchen@haloailabs.com> Co-authored-by: Matt Hallowell <17804673+mhallo@users.noreply.github.com> Co-authored-by: nate nowack <thrast36@gmail.com> Co-authored-by: Bill Easton <williamseaston@gmail.com> Co-authored-by: Marcus Shu <46469249+shulkx@users.noreply.github.com> Co-authored-by: Rushabh Doshi <radoshi@gmail.com> Co-authored-by: AIKAWA Shigechika <shige@aikawa.jp> Co-authored-by: Jeremy Simon <simonjer805@gmail.com> Co-authored-by: Miguel Miranda Dias <7780875+pandego@users.noreply.github.com> Co-authored-by: Anthony James Padavano <padavano.anthony@gmail.com> Co-authored-by: Mostafa Kamal <hiremostafa@gmail.com> Fix auto-close MRE script posting comment without closing (#3386) Fix WorkOS token scope verification bypass 🤖 Generated with Codex (#3407) Fix initialize McpError fallthrough 🤖 Generated with Codex (#3413) Fix transform arg collisions with passthrough params (#3431) Fix get_* returning None when latest version is disabled (#3439) Fix get_* returning None when latest version is disabled (#3421) Fix server lifespan overlap teardown (#3415) Fix $ref output schema object detection regression (#3420) resolved annotations (#3429) Fix async partial callables rejected by iscoroutinefunction (#3438) Fix async partial callables rejected by iscoroutinefunction (#3423) fix: add version to components (#3458) fix: use intent-based flag for OIDC scope patch in load_access_token (#3465) Fixes #3461 fix: normalize Google scope shorthands and surface valid_scopes (#3477) fix: resolve ty 0.0.23 type-checking errors and bump pin (#3481) fix: shield lifespan teardown from cancellation (#3480) fix: forward custom_route endpoints from mounted servers (#3462) fix updates _get_additional_http_routes() to traverse providers, Fixes #3457 fix: remove hardcoded version from CLI help text (#3456) fix: monty 0.0.8 compatibility, drop external_functions from constructor (#3468) fix: task test teardown hanging 5s per test (#3499) Closes #3498 fix: validate workspace path is a directory before cursor install (#3440) Fixes #3426 fix: handle re.error from malformed URI templates in build_regex (#3501) fix: reject empty/OIDC-only required_scopes in AzureProvider (#3503) fix: restrict $ref resolution to local refs only (SSRF/LFI) (#3502) fix warnings and timeouts (#3504) close upgrade check issue when build passes (#3505) Closes #3484 fix: URL-encode path params to prevent SSRF/path traversal (GHSA-vv7q-7jx5-f767) (#3507) fix: prevent path traversal in skill download (#3493) fix: prefer IdP-granted scopes over client-requested scopes in OAuthProxy (#3492) fix: remove unrelated transform and http.py changes from PR scope fix: remove forced follow_redirects from httpx_client_factory calls (#3496) fix: stop passing follow_redirects to httpx_client_factory fix: restore follow_redirects=True for custom httpx client factories Closes #3509 fix: CSRF double-submit cookie check in consent flow (#3519) fix: validate server names in install commands (#3522) fix: use raw strings for regex in pytest.raises match (#3523) fix: reject refresh tokens used as Bearer access tokens (#3524) fix: route ResourcesAsTools/PromptsAsTools through server middleware (#3495) fix: resolve Pyright "Module is not callable" on @tool, @resource, @prompt decorators (#3540) fix: filter warnings by message in KEY_PREFIX test (#3549) fix: suppress output schema for ToolResult subclass annotations (#3548) fix: increase sleep duration in proxy cache tests (#3567) fix: store absolute token expiry to prevent stale expires_in on reload (#3572) fix: preserve tool properties named 'title' during schema compression (#3582) Fix loopback redirect URI port matching per RFC 8252 §7.3 (#3589) Fix app tool routing: visibility check and middleware propagation (#3591) Fix query parameter serialization to respect OpenAPI explode/style settings (#3595) Fix dev apps form: union types, textarea support, JSON parsing (#3597) fix(google): replace deprecated /oauth2/v1/tokeninfo with /oauth2/v3/userinfo (#3603) fix: resolve EntraOBOToken dependency injection through MultiAuth (#3609) fix(docs): correct misleading stateless_http header (#3622) fix: filesystem provider import machinery (#3626) Closes #3625 (issues 2, 3, 6) fix: recover StdioTransport after subprocess exits (#3630) fix(server): preserve mounted tool task metadata (#3632) fix: scope deprecation warning filter to FastMCPDeprecationWarning (#3649) fix imports, add PrefabAppConfig (#3650) fix: resolve CurrentFastMCP/ctx.fastmcp to child server in mounted background tasks (#3651) Fix blocking docs issues: chart imports, Select API, Rx consistency (#3652) closed by default (#3657) Fix prompt caching middleware missing wrap/unwrap round-trip (#3666) fix: serialize object query params per OpenAPI style/explode rules (#3662) Fixes #2857 fix: HTTP request headers not accessible in background task workers (#3631) fix: restore HTTP headers in worker execution path for background tasks (#3681) fix: strip discriminator after dereferencing schemas (#3682) fix: remove stale ty:ignore directives for ty 0.0.26 (#3684) Fix docs gaps in app provider pages (#3690) fix: dev apps log panel UX improvements (#3698) fix dev server empty string args (#3700)
166 lines
7.1 KiB
Text
166 lines
7.1 KiB
Text
---
|
|
title: Running Servers
|
|
sidebarTitle: Running
|
|
description: Start, develop, and configure servers from the command line
|
|
icon: play
|
|
---
|
|
|
|
import { VersionBadge } from '/snippets/version-badge.mdx'
|
|
|
|
## Starting a Server
|
|
|
|
`fastmcp run` starts a server. Point it at a Python file, a factory function, a remote URL, or a config file:
|
|
|
|
```bash
|
|
fastmcp run server.py
|
|
fastmcp run server.py:create_server
|
|
fastmcp run https://example.com/mcp
|
|
fastmcp run fastmcp.json
|
|
```
|
|
|
|
By default, the server runs over **stdio** — the transport that MCP clients like Claude Desktop expect. To serve over HTTP instead, specify the transport:
|
|
|
|
```bash
|
|
fastmcp run server.py --transport http
|
|
fastmcp run server.py --transport http --host 0.0.0.0 --port 9000
|
|
```
|
|
|
|
### Entrypoints
|
|
|
|
FastMCP supports several ways to locate and start your server:
|
|
|
|
**Inferred instance** — FastMCP imports the file and looks for a variable named `mcp`, `server`, or `app`:
|
|
|
|
```bash
|
|
fastmcp run server.py
|
|
```
|
|
|
|
**Explicit instance** — point at a specific variable:
|
|
|
|
```bash
|
|
fastmcp run server.py:my_server
|
|
```
|
|
|
|
**Factory function** — FastMCP calls the function and uses the returned server. Useful when your server needs async setup or configuration that runs before startup:
|
|
|
|
```bash
|
|
fastmcp run server.py:create_server
|
|
```
|
|
|
|
**Remote URL** — starts a local proxy that bridges to a remote server. Handy for local development against a deployed server, or for bridging a remote HTTP server to stdio:
|
|
|
|
```bash
|
|
fastmcp run https://example.com/mcp
|
|
```
|
|
|
|
**FastMCP config** — uses a `fastmcp.json` file that declaratively specifies the server, its dependencies, and deployment settings. When you run `fastmcp run` with no arguments, it auto-detects `fastmcp.json` in the current directory:
|
|
|
|
```bash
|
|
fastmcp run
|
|
fastmcp run my-config.fastmcp.json
|
|
```
|
|
|
|
See [Server Configuration](/deployment/server-configuration) for the full `fastmcp.json` format.
|
|
|
|
**MCP config** — runs servers defined in a standard MCP configuration file (any `.json` with an `mcpServers` key):
|
|
|
|
```bash
|
|
fastmcp run mcp.json
|
|
```
|
|
|
|
<Warning>
|
|
`fastmcp run` completely ignores the `if __name__ == "__main__"` block. Any setup code in that block won't execute. If you need initialization logic to run, use a [factory function](/cli/overview#factory-functions).
|
|
</Warning>
|
|
|
|
### Options
|
|
|
|
| Option | Flag | Description |
|
|
| ------ | ---- | ----------- |
|
|
| Transport | `--transport`, `-t` | `stdio` (default), `http`, or `sse` |
|
|
| Host | `--host` | Bind address for HTTP (default: `127.0.0.1`) |
|
|
| Port | `--port`, `-p` | Bind port for HTTP (default: `8000`) |
|
|
| Path | `--path` | URL path for HTTP (default: `/mcp/`) |
|
|
| Log Level | `--log-level`, `-l` | `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` |
|
|
| No Banner | `--no-banner` | Suppress the startup banner |
|
|
| Auto-Reload | `--reload` / `--no-reload` | Watch for file changes and restart automatically |
|
|
| Reload Dirs | `--reload-dir` | Directories to watch (repeatable) |
|
|
| Skip Env | `--skip-env` | Don't set up a uv environment (use when already in one) |
|
|
| Python | `--python` | Python version to use (e.g., `3.11`) |
|
|
| Extra Packages | `--with` | Additional packages to install (repeatable) |
|
|
| Project | `--project` | Run within a specific uv project directory |
|
|
| Requirements | `--with-requirements` | Install from a requirements file |
|
|
|
|
### Dependency Management
|
|
|
|
By default, `fastmcp run` uses your current Python environment directly. When you pass `--python`, `--with`, `--project`, or `--with-requirements`, it switches to running via `uv run` in a subprocess, which handles dependency isolation automatically.
|
|
|
|
The `--skip-env` flag is useful when you're already inside an activated venv, a Docker container with pre-installed dependencies, or a uv-managed project — it prevents uv from trying to set up another environment layer.
|
|
|
|
## Previewing Apps
|
|
|
|
<VersionBadge version="3.2.0" />
|
|
|
|
`fastmcp dev apps` launches a browser-based preview UI for servers with [Prefab App tools](/apps/prefab). It starts your MCP server on one port and a local dev UI on another — giving you a live, interactive picker where you can call app tools and see their rendered output without needing a full MCP host client.
|
|
|
|
```bash
|
|
fastmcp dev apps server.py
|
|
fastmcp dev apps server.py:mcp --mcp-port 9000 --dev-port 9090
|
|
```
|
|
|
|
The picker auto-generates a form from each tool's input schema. Submit the form and the result opens in a new tab as a rendered Prefab UI.
|
|
|
|
Auto-reload is on by default — save a file and the MCP server restarts automatically.
|
|
|
|
<Tip>
|
|
`fastmcp dev apps` requires `fastmcp[apps]` — install with `pip install "fastmcp[apps]"`.
|
|
</Tip>
|
|
|
|
| Option | Flag | Description |
|
|
| ------ | ---- | ----------- |
|
|
| MCP Port | `--mcp-port` | Port for the MCP server (default: `8000`) |
|
|
| Dev Port | `--dev-port` | Port for the dev UI (default: `8080`) |
|
|
| Auto-Reload | `--reload` / `--no-reload` | Watch for file changes (default: on) |
|
|
|
|
## Development with the Inspector
|
|
|
|
`fastmcp dev inspector` launches your server inside the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), a browser-based tool for interactively testing MCP servers. Auto-reload is on by default, so your server restarts when you save changes.
|
|
|
|
```bash
|
|
fastmcp dev inspector server.py
|
|
fastmcp dev inspector server.py -e . --with pandas
|
|
```
|
|
|
|
<Tip>
|
|
The Inspector always runs your server via `uv run` in a subprocess — it never uses your local environment directly. Specify dependencies with `--with`, `--with-editable`, `--with-requirements`, or through a `fastmcp.json` file.
|
|
</Tip>
|
|
|
|
<Warning>
|
|
The Inspector connects over **stdio only**. When it launches, you may need to select "STDIO" from the transport dropdown and click connect. To test a server over HTTP, start it separately with `fastmcp run server.py --transport http` and point the Inspector at the URL.
|
|
</Warning>
|
|
|
|
| Option | Flag | Description |
|
|
| ------ | ---- | ----------- |
|
|
| Editable Package | `--with-editable`, `-e` | Install a directory in editable mode |
|
|
| Extra Packages | `--with` | Additional packages (repeatable) |
|
|
| Inspector Version | `--inspector-version` | MCP Inspector version to use |
|
|
| UI Port | `--ui-port` | Port for the Inspector UI |
|
|
| Server Port | `--server-port` | Port for the Inspector proxy |
|
|
| Auto-Reload | `--reload` / `--no-reload` | File watching (default: on) |
|
|
| Reload Dirs | `--reload-dir` | Directories to watch (repeatable) |
|
|
| Python | `--python` | Python version |
|
|
| Project | `--project` | Run within a uv project directory |
|
|
| Requirements | `--with-requirements` | Install from a requirements file |
|
|
|
|
## Pre-Building Environments
|
|
|
|
`fastmcp project prepare` creates a persistent uv project from a `fastmcp.json` file, pre-installing all dependencies. This separates environment setup from server execution — install once, run many times.
|
|
|
|
```bash
|
|
# Step 1: Build the environment (slow, does dependency resolution)
|
|
fastmcp project prepare fastmcp.json --output-dir ./env
|
|
|
|
# Step 2: Run using the prepared environment (fast, no install step)
|
|
fastmcp run fastmcp.json --project ./env
|
|
```
|
|
|
|
The prepared directory contains a `pyproject.toml`, a `.venv` with all packages installed, and a `uv.lock` for reproducibility. This is particularly useful in deployment scenarios where you want deterministic, pre-built environments.
|