60e0ffc959
Upgrade checks / Notify on failure (push) Has been cancelled
Upgrade checks / Close issue on success (push) Has been cancelled
Schema Crash Test / Real-world schema crash test (232K schemas) (push) Has been cancelled
Run static analysis / static_analysis (push) Has been cancelled
Tests / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Tests / Tests with lowest-direct dependencies (push) Has been cancelled
Tests / MCP conformance tests (push) Has been cancelled
Tests / Integration tests (push) Has been cancelled
Tests / Package install smoke (push) Has been cancelled
Upgrade checks / Static analysis (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Upgrade checks / Integration tests (push) Has been cancelled
Update MCPServerConfig Schema / update-config-schema (push) Has been cancelled
Update SDK Documentation / update-sdk-docs (push) Has been cancelled
165 lines
6.0 KiB
Plaintext
165 lines
6.0 KiB
Plaintext
---
|
|
title: Quickstart
|
|
icon: rocket-launch
|
|
---
|
|
|
|
Welcome! This guide will help you quickly set up FastMCP, run your first MCP server, give it a visual UI, and deploy it to Prefect Horizon.
|
|
|
|
If you haven't already installed FastMCP, follow the [installation instructions](/getting-started/installation).
|
|
|
|
## Create a FastMCP Server
|
|
|
|
A FastMCP server is a collection of tools, resources, and other MCP components. To create a server, start by instantiating the `FastMCP` class.
|
|
|
|
Create a new file called `my_server.py` and add the following code:
|
|
|
|
```python my_server.py
|
|
from fastmcp import FastMCP
|
|
|
|
mcp = FastMCP("My MCP Server")
|
|
```
|
|
|
|
|
|
That's it! You've created a FastMCP server, albeit a very boring one. Let's add a tool to make it more interesting.
|
|
|
|
|
|
## Add a Tool
|
|
|
|
To add a tool that returns a simple greeting, write a function and decorate it with `@mcp.tool` to register it with the server:
|
|
|
|
```python my_server.py {5-7}
|
|
from fastmcp import FastMCP
|
|
|
|
mcp = FastMCP("My MCP Server")
|
|
|
|
@mcp.tool
|
|
def greet(name: str) -> str:
|
|
return f"Hello, {name}!"
|
|
```
|
|
|
|
|
|
## Run the Server
|
|
|
|
The simplest way to run your FastMCP server is to call its `run()` method. You can choose between different transports, like `stdio` for local servers, or `http` for remote access:
|
|
|
|
<CodeGroup>
|
|
|
|
```python my_server.py (stdio) {9, 10}
|
|
from fastmcp import FastMCP
|
|
|
|
mcp = FastMCP("My MCP Server")
|
|
|
|
@mcp.tool
|
|
def greet(name: str) -> str:
|
|
return f"Hello, {name}!"
|
|
|
|
if __name__ == "__main__":
|
|
mcp.run()
|
|
```
|
|
|
|
```python my_server.py (HTTP) {9, 10}
|
|
from fastmcp import FastMCP
|
|
|
|
mcp = FastMCP("My MCP Server")
|
|
|
|
@mcp.tool
|
|
def greet(name: str) -> str:
|
|
return f"Hello, {name}!"
|
|
|
|
if __name__ == "__main__":
|
|
mcp.run(transport="http", port=8000)
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
This lets us run the server with `python my_server.py`. The stdio transport is the traditional way to connect MCP servers to clients, while the HTTP transport enables remote connections.
|
|
|
|
<Tip>
|
|
Why do we need the `if __name__ == "__main__":` block?
|
|
|
|
The `__main__` block is recommended for consistency and compatibility, ensuring your server works with all MCP clients that execute your server file as a script. Users who will exclusively run their server with the FastMCP CLI can omit it, as the CLI imports the server object directly.
|
|
</Tip>
|
|
|
|
### Using the FastMCP CLI
|
|
|
|
You can also use the `fastmcp run` command to start your server. Note that the FastMCP CLI **does not** execute the `__main__` block of your server file. Instead, it imports your server object and runs it with whatever transport and options you provide.
|
|
|
|
For example, to run this server with the default stdio transport (no matter how you called `mcp.run()`), you can use the following command:
|
|
```bash
|
|
fastmcp run my_server.py:mcp
|
|
```
|
|
|
|
To run this server with the HTTP transport, you can use the following command:
|
|
```bash
|
|
fastmcp run my_server.py:mcp --transport http --port 8000
|
|
```
|
|
|
|
## Call Your Server
|
|
|
|
Once your server is running with HTTP transport, you can connect to it with a FastMCP client or any LLM client that supports the MCP protocol:
|
|
|
|
```python my_client.py
|
|
import asyncio
|
|
from fastmcp import Client
|
|
|
|
client = Client("http://localhost:8000/mcp")
|
|
|
|
async def call_tool(name: str):
|
|
async with client:
|
|
result = await client.call_tool("greet", {"name": name})
|
|
print(result)
|
|
|
|
asyncio.run(call_tool("Ford"))
|
|
```
|
|
|
|
Note that:
|
|
- FastMCP clients are asynchronous, so we need to use `asyncio.run` to run the client
|
|
- We must enter a client context (`async with client:`) before using the client
|
|
- You can make multiple client calls within the same context
|
|
|
|
## Give Your Tool a UI
|
|
|
|
Tools normally return text, but any tool can return an interactive UI instead. Add `app=True` to your tool decorator and return a [Prefab](https://prefab.prefect.io) component — the host renders it as a chart, table, form, or any other visual element right in the conversation. This requires the `apps` extra (`pip install "fastmcp[apps]"`).
|
|
|
|
The `app=True` flag tells FastMCP to wire up the renderer and protocol metadata automatically. The tool still works like any other MCP tool — it receives arguments and returns a result — but the result is a component tree that the host displays visually instead of as plain text.
|
|
|
|
```python my_server.py
|
|
from prefab_ui.app import PrefabApp
|
|
from prefab_ui.components import Column, Heading, Text, Badge, Row
|
|
from fastmcp import FastMCP
|
|
|
|
mcp = FastMCP("My MCP Server")
|
|
|
|
|
|
@mcp.tool(app=True)
|
|
def greet(name: str) -> PrefabApp:
|
|
"""Greet someone with a visual card."""
|
|
with Column(gap=4, css_class="p-6") as view:
|
|
Heading(f"Hello, {name}!")
|
|
with Row(gap=2, align="center"):
|
|
Text("Status")
|
|
Badge("Greeted", variant="success")
|
|
|
|
return PrefabApp(view=view)
|
|
```
|
|
|
|
You can preview app tools locally with `fastmcp dev apps my_server.py` — no MCP host required. See the [Apps overview](/apps/overview) for the full guide, including state management, forms, charts, and server-connected interactivity.
|
|
|
|
## Deploy to Prefect Horizon
|
|
|
|
[Prefect Horizon](https://horizon.prefect.io?utm_source=gofastmcp&utm_medium=docs) is the enterprise MCP platform built by the FastMCP team at [Prefect](https://www.prefect.io). It provides managed hosting, authentication, access control, and observability for MCP servers.
|
|
|
|
<Info>
|
|
Horizon is **free for personal projects** and offers enterprise governance for teams.
|
|
</Info>
|
|
|
|
To deploy your server, you'll need a [GitHub account](https://github.com). Once you have one, you can deploy your server in three steps:
|
|
|
|
1. Push your `my_server.py` file to a GitHub repository
|
|
2. Sign in to [Prefect Horizon](https://horizon.prefect.io?utm_source=gofastmcp&utm_medium=docs) with your GitHub account
|
|
3. Create a new project from your repository and enter `my_server.py:mcp` as the server entrypoint
|
|
|
|
That's it! Horizon will build and deploy your server, making it available at a URL like `https://your-project.fastmcp.app/mcp`. You can chat with it to test its functionality, or connect to it from any LLM client that supports the MCP protocol.
|
|
|
|
For more details, see the [Prefect Horizon guide](/deployment/prefect-horizon).
|