π The fast, Pythonic way to build MCP servers and clients.
Add empty parens to docs
Jeremiah Lowinb3f80c5374ce
diff --git a/README.md b/README.mdindex 082c4dc22..7374fa6b1 100644--- a/README.md+++ b/README.md@@ -31,7 +31,7 @@ from fastmcp import FastMCPmcp = FastMCP("Demo π")def add(a: int, b: int) -> int:"""Add two numbers"""return a + b@@ -144,7 +144,7 @@ Learn more in the [**FastMCP Server Documentation**](https://gofastmcp.com/serveTools allow LLMs to perform actions by executing your Python functions (sync or async). Ideal for computations, API calls, or side effects (like `POST`/`PUT`). FastMCP handles schema generation from type hints and docstrings. Tools can return various types, including text, JSON-serializable objects, and even images using the [`fastmcp.Image`](https://gofastmcp.com/servers/tools#return-values) helper.```pythondef multiply(a: float, b: float) -> float:"""Multiplies two numbers."""return a * b@@ -176,7 +176,7 @@ Learn more in the [**Resources & Templates Documentation**](https://gofastmcp.coPrompts define reusable message templates to guide LLM interactions. Decorate functions with `@mcp.prompt`. Return strings or `Message` objects.```pythondef summarize_request(text: str) -> str:"""Generate a prompt asking for a summary."""return f"Please summarize the following text:\n\n{text}"@@ -201,7 +201,7 @@ from fastmcp import FastMCP, Contextmcp = FastMCP("My MCP Server")async def process_data(uri: str, ctx: Context):# Log a message to the clientawait ctx.info(f"Processing {uri}...")@@ -321,7 +321,7 @@ from fastmcp import FastMCPmcp = FastMCP("Demo π")def hello(name: str) -> str:return f"Hello, {name}!"diff --git a/docs/clients/transports.mdx b/docs/clients/transports.mdxindex 94c94833c..6ed9fc489 100644--- a/docs/clients/transports.mdx+++ b/docs/clients/transports.mdx@@ -359,7 +359,7 @@ import asyncio# 1. Create your FastMCP server instanceserver = FastMCP(name="InMemoryServer")def ping():return "pong"diff --git a/docs/deployment/asgi.mdx b/docs/deployment/asgi.mdxindex 06da46374..ace7ee136 100644--- a/docs/deployment/asgi.mdx+++ b/docs/deployment/asgi.mdx@@ -32,7 +32,7 @@ from fastmcp import FastMCPmcp = FastMCP("MyServer")def hello(name: str) -> str:return f"Hello, {name}!"diff --git a/docs/deployment/running-server.mdx b/docs/deployment/running-server.mdxindex 5b6a7eadd..5f5d758d2 100644--- a/docs/deployment/running-server.mdx+++ b/docs/deployment/running-server.mdx@@ -22,7 +22,7 @@ from fastmcp import FastMCPmcp = FastMCP(name="MyServer")def hello(name: str) -> str:return f"Hello, {name}!"@@ -244,7 +244,7 @@ import asynciomcp = FastMCP(name="MyServer")def hello(name: str) -> str:return f"Hello, {name}!"diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdxindex b3569d486..13a6bbae5 100644--- a/docs/getting-started/quickstart.mdx+++ b/docs/getting-started/quickstart.mdx@@ -32,7 +32,7 @@ from fastmcp import FastMCPmcp = FastMCP("My MCP Server")def greet(name: str) -> str:return f"Hello, {name}!"```@@ -49,7 +49,7 @@ from fastmcp import FastMCP, Clientmcp = FastMCP("My MCP Server")def greet(name: str) -> str:return f"Hello, {name}!"@@ -76,7 +76,7 @@ from fastmcp import FastMCPmcp = FastMCP("My MCP Server")def greet(name: str) -> str:return f"Hello, {name}!"diff --git a/docs/getting-started/welcome.mdx b/docs/getting-started/welcome.mdxindex d9d921a7a..f5574217c 100644--- a/docs/getting-started/welcome.mdx+++ b/docs/getting-started/welcome.mdx@@ -14,7 +14,7 @@ from fastmcp import FastMCPmcp = FastMCP("Demo π")def add(a: int, b: int) -> int:"""Add two numbers"""return a + bdiff --git a/docs/integrations/anthropic.mdx b/docs/integrations/anthropic.mdxindex bcea25769..0920afce2 100644--- a/docs/integrations/anthropic.mdx+++ b/docs/integrations/anthropic.mdx@@ -27,7 +27,7 @@ from fastmcp import FastMCPmcp = FastMCP(name="Dice Roller")def roll_dice(n_dice: int) -> list[int]:"""Roll `n_dice` 6-sided dice and return the results."""return [random.randint(1, 6) for _ in range(n_dice)]@@ -170,7 +170,7 @@ auth = BearerAuthProvider(mcp = FastMCP(name="Dice Roller", auth=auth)def roll_dice(n_dice: int) -> list[int]:"""Roll `n_dice` 6-sided dice and return the results."""return [random.randint(1, 6) for _ in range(n_dice)]diff --git a/docs/integrations/claude-desktop.mdx b/docs/integrations/claude-desktop.mdxindex 9b8dc5404..7edafa68b 100644--- a/docs/integrations/claude-desktop.mdx+++ b/docs/integrations/claude-desktop.mdx@@ -31,7 +31,7 @@ from fastmcp import FastMCPmcp = FastMCP(name="Dice Roller")def roll_dice(n_dice: int) -> list[int]:"""Roll `n_dice` 6-sided dice and return the results."""return [random.randint(1, 6) for _ in range(n_dice)]diff --git a/docs/integrations/gemini.mdx b/docs/integrations/gemini.mdxindex 46ffd7a9d..d61d0feb0 100644--- a/docs/integrations/gemini.mdx+++ b/docs/integrations/gemini.mdx@@ -31,7 +31,7 @@ from fastmcp import FastMCPmcp = FastMCP(name="Dice Roller")def roll_dice(n_dice: int) -> list[int]:"""Roll `n_dice` 6-sided dice and return the results."""return [random.randint(1, 6) for _ in range(n_dice)]diff --git a/docs/integrations/openai.mdx b/docs/integrations/openai.mdxindex 52f3bb164..86f01e626 100644--- a/docs/integrations/openai.mdx+++ b/docs/integrations/openai.mdx@@ -32,7 +32,7 @@ from fastmcp import FastMCPmcp = FastMCP(name="Dice Roller")def roll_dice(n_dice: int) -> list[int]:"""Roll `n_dice` 6-sided dice and return the results."""return [random.randint(1, 6) for _ in range(n_dice)]@@ -165,7 +165,7 @@ auth = BearerAuthProvider(mcp = FastMCP(name="Dice Roller", auth=auth)def roll_dice(n_dice: int) -> list[int]:"""Roll `n_dice` 6-sided dice and return the results."""return [random.randint(1, 6) for _ in range(n_dice)]diff --git a/docs/patterns/cli.mdx b/docs/patterns/cli.mdxindex 19e1ad1ab..b46d928d4 100644--- a/docs/patterns/cli.mdx+++ b/docs/patterns/cli.mdx@@ -66,7 +66,7 @@ from fastmcp import FastMCPmcp = FastMCP("MyServer")def hello(name: str) -> str:return f"Hello, {name}!"diff --git a/docs/patterns/decorating-methods.mdx b/docs/patterns/decorating-methods.mdxindex b4ac48072..587e2dbb7 100644--- a/docs/patterns/decorating-methods.mdx+++ b/docs/patterns/decorating-methods.mdx@@ -28,7 +28,7 @@ from fastmcp import FastMCPmcp = FastMCP()class MyClass:- @mcp.tool # This won't work correctly[email protected]() # This won't work correctlydef add(self, x, y):return x + y@@ -83,7 +83,7 @@ mcp = FastMCP()class MyClass:@classmethod- @mcp.tool # This won't work correctly[email protected]() # This won't work correctlydef from_string(cls, s):return cls(s)```@@ -122,7 +122,7 @@ mcp = FastMCP()class MyClass:@staticmethod- @mcp.tool # This works![email protected]() # This works!def utility(x, y):return x + ydiff --git a/docs/patterns/http-requests.mdx b/docs/patterns/http-requests.mdxindex c9b412c5d..ceb333e19 100644--- a/docs/patterns/http-requests.mdx+++ b/docs/patterns/http-requests.mdx@@ -25,7 +25,7 @@ from starlette.requests import Requestmcp = FastMCP(name="HTTP Request Demo")async def user_agent_info() -> dict:"""Return information about the user agent."""# Get the HTTP request@@ -58,7 +58,7 @@ from fastmcp.server.dependencies import get_http_headersmcp = FastMCP(name="Headers Demo")async def safe_header_info() -> dict:"""Safely get header information without raising errors."""# Get headers (returns empty dict if no request context)diff --git a/docs/patterns/testing.mdx b/docs/patterns/testing.mdxindex adc3f516a..c8df2c759 100644--- a/docs/patterns/testing.mdx+++ b/docs/patterns/testing.mdx@@ -22,7 +22,7 @@ from fastmcp import FastMCP, Clientdef mcp_server():server = FastMCP("TestServer")- @server.tooldef greet(name: str) -> str:return f"Hello, {name}!"diff --git a/docs/servers/auth/bearer.mdx b/docs/servers/auth/bearer.mdxindex 13053b5b2..c695c10e6 100644--- a/docs/servers/auth/bearer.mdx+++ b/docs/servers/auth/bearer.mdx@@ -159,7 +159,7 @@ Once authenticated, your tools, resources, or prompts can access token informatifrom fastmcp import FastMCP, Context, ToolErrorfrom fastmcp.server.dependencies import get_access_token, AccessTokenasync def get_my_data(ctx: Context) -> dict:access_token: AccessToken = get_access_token()diff --git a/docs/servers/composition.mdx b/docs/servers/composition.mdxindex 04dc559d0..b1519b3f3 100644--- a/docs/servers/composition.mdx+++ b/docs/servers/composition.mdx@@ -50,7 +50,7 @@ import asyncio# Define subserversweather_mcp = FastMCP(name="WeatherService")-@weather_mcp.tool+@weather_mcp.tool()def get_forecast(city: str) -> dict:"""Get weather forecast."""return {"city": city, "forecast": "Sunny"}@@ -102,7 +102,7 @@ from fastmcp import FastMCP, Client# Define subserverdynamic_mcp = FastMCP(name="DynamicService")-@dynamic_mcp.tool+@dynamic_mcp.tool()def initial_tool():"""Initial tool demonstration."""return "Initial Tool Exists"@@ -112,7 +112,7 @@ main_mcp = FastMCP(name="MainAppLive")main_mcp.mount("dynamic", dynamic_mcp)# Add a tool AFTER mounting - it will be accessible through main_mcp-@dynamic_mcp.tool+@dynamic_mcp.tool()def added_later():"""Tool added after mounting."""return "Tool Added Dynamically!"diff --git a/docs/servers/context.mdx b/docs/servers/context.mdxindex 0f075d264..555a0c105 100644--- a/docs/servers/context.mdx+++ b/docs/servers/context.mdx@@ -41,7 +41,7 @@ from fastmcp import FastMCP, Contextmcp = FastMCP(name="ContextDemo")async def process_file(file_uri: str, ctx: Context) -> str:"""Processes a file, using context for logging and resource access."""# Context is available as the ctx parameter@@ -71,7 +71,7 @@ async def get_user_profile(user_id: str, ctx: Context) -> dict:<VersionBadge version="2.2.5" />```pythonasync def data_analysis_request(dataset: str, ctx: Context) -> str:"""Generate a request to analyze data with contextual information."""# Context is available as the ctx parameter@@ -99,7 +99,7 @@ async def process_data(data: list[float]) -> dict:ctx = get_context()await ctx.info(f"Processing {len(data)} data points")async def analyze_dataset(dataset_name: str) -> dict:# Call utility function that uses context internallydata = load_data(dataset_name)@@ -118,7 +118,7 @@ async def analyze_dataset(dataset_name: str) -> dict:Send log messages back to the MCP client. This is useful for debugging and providing visibility into function execution during a request.```pythonasync def analyze_data(data: list[float], ctx: Context) -> dict:"""Analyze numerical data with logging."""await ctx.debug("Starting analysis of numerical data")@@ -149,7 +149,7 @@ async def analyze_data(data: list[float], ctx: Context) -> dict:For long-running operations, notify the client about the progress. This allows clients to display progress indicators and provide a better user experience.```pythonasync def process_items(items: list[str], ctx: Context) -> dict:"""Process a list of items with progress updates."""total = len(items)@@ -182,7 +182,7 @@ Progress reporting requires the client to have sent a `progressToken` in the iniRead data from resources registered with your FastMCP server. This allows functions to access files, configuration, or dynamically generated content.```pythonasync def summarize_document(document_uri: str, ctx: Context) -> str:"""Summarize a document by its resource URI."""# Read the document content@@ -222,7 +222,7 @@ The returned content is typically accessed via `content_list[0].content` and canRequest the client's LLM to generate text based on provided messages. This is useful when your function needs to leverage the LLM's capabilities to process data or generate responses.```pythonasync def analyze_sentiment(text: str, ctx: Context) -> dict:"""Analyze the sentiment of a text using the client's LLM."""# Create a sampling prompt asking for sentiment analysis@@ -258,7 +258,7 @@ async def analyze_sentiment(text: str, ctx: Context) -> dict:When providing a simple string, it's treated as a user message. For more complex scenarios, you can provide a list of messages with different roles.```pythonasync def generate_example(concept: str, ctx: Context) -> str:"""Generate a Python code example for a given concept."""# Using a system prompt and a user message@@ -280,7 +280,7 @@ See [Client Sampling](/clients/client#llm-sampling) for more details on how clieAccess metadata about the current request and client.```pythonasync def request_info(ctx: Context) -> dict:"""Return information about the current request."""return {@@ -300,7 +300,7 @@ async def request_info(ctx: Context) -> dict:#### FastMCP Server and Sessions```pythonasync def advanced_tool(ctx: Context) -> str:"""Demonstrate advanced context access."""# Access the FastMCP server instance@@ -326,7 +326,7 @@ See the [HTTP Requests pattern](/patterns/http-requests) for more details.For web applications, you can access the underlying HTTP request:```pythonasync def handle_web_request(ctx: Context) -> dict:"""Access HTTP request information from the Starlette request."""request = ctx.get_http_request()diff --git a/docs/servers/fastmcp.mdx b/docs/servers/fastmcp.mdxindex 13279525d..598d056b6 100644--- a/docs/servers/fastmcp.mdx+++ b/docs/servers/fastmcp.mdx@@ -47,7 +47,7 @@ FastMCP servers expose several types of components to the client:Tools are functions that the client can call to perform actions or access external systems.```pythondef multiply(a: float, b: float) -> float:"""Multiplies two numbers together."""return a * b@@ -87,7 +87,7 @@ See [Resources & Templates](/servers/resources) for detailed documentation.Prompts are reusable message templates for guiding the LLM.```pythondef analyze_data(data_points: list[float]) -> str:"""Creates a prompt asking for analysis of numerical data."""formatted_data = ", ".join(str(point) for point in data_points)@@ -106,7 +106,7 @@ from fastmcp import FastMCPmcp = FastMCP(name="MyServer")def greet(name: str) -> str:"""Greet a user by name."""return f"Hello, {name}!"@@ -145,7 +145,7 @@ import asynciomain = FastMCP(name="Main")sub = FastMCP(name="Sub")def hello():return "hi"@@ -216,7 +216,7 @@ def yaml_serializer(data):# Create a server with the custom serializermcp = FastMCP(name="MyServer", tool_serializer=yaml_serializer)def get_config():"""Returns configuration in YAML format."""return {"api_key": "abc123", "debug": True, "rate_limit": 100}diff --git a/docs/servers/prompts.mdx b/docs/servers/prompts.mdxindex 47f19ff9e..6a8f0a62a 100644--- a/docs/servers/prompts.mdx+++ b/docs/servers/prompts.mdx@@ -33,13 +33,13 @@ from fastmcp.prompts.prompt import Message, PromptMessage, TextContentmcp = FastMCP(name="PromptServer")# Basic prompt returning a string (converted to user message automatically)def ask_about_topic(topic: str) -> str:"""Generates a user message asking for an explanation of a topic."""return f"Can you please explain the concept of '{topic}'?"# Prompt returning a specific message typedef generate_code_request(language: str, task_description: str) -> PromptMessage:"""Generates a user message requesting code generation."""content = f"Write a {language} function that performs the following task: {task_description}"@@ -69,7 +69,7 @@ FastMCP intelligently handles different return types from your prompt function:```pythonfrom fastmcp.prompts.prompt import Messagedef roleplay_scenario(character: str, situation: str) -> list[Message]:"""Sets up a roleplaying scenario with initial messages."""return [@@ -89,7 +89,7 @@ Type annotations are important for prompts. They:from pydantic import Fieldfrom typing import Literal, Optionaldef generate_content_request(topic: str = Field(description="The main subject to cover"),format: Literal["blog", "email", "social"] = "blog",@@ -111,7 +111,7 @@ def generate_content_request(Parameters in your function signature are considered **required** unless they have a default value.```pythondef data_analysis_prompt(data_uri: str, # Required - no default valueanalysis_type: str = "summary", # Optional - has default value@@ -154,13 +154,13 @@ FastMCP seamlessly supports both standard (`def`) and asynchronous (`async def`)```python# Synchronous promptdef simple_question(question: str) -> str:"""Generates a simple question to ask the LLM."""return f"Question: {question}"# Asynchronous promptasync def data_based_prompt(data_id: str) -> str:"""Generates a prompt based on data that needs to be fetched."""# In a real scenario, you might fetch data from a database or API@@ -183,7 +183,7 @@ from fastmcp import FastMCP, Contextmcp = FastMCP(name="PromptServer")async def generate_report_request(report_type: str, ctx: Context) -> str:"""Generates a request for a report."""return f"Please create a {report_type} report. Request ID: {ctx.request_id}"@@ -207,7 +207,7 @@ mcp = FastMCP(on_duplicate_prompts="error" # Raise an error if a prompt name is duplicated)def greeting(): return "Hello, how can I help you today?"# This registration attempt will raise a ValueError becausediff --git a/docs/servers/proxy.mdx b/docs/servers/proxy.mdxindex 5a9bffccd..d78d6d694 100644--- a/docs/servers/proxy.mdx+++ b/docs/servers/proxy.mdx@@ -90,7 +90,7 @@ from fastmcp import FastMCP# Original serveroriginal_server = FastMCP(name="Original")-@original_server.tool+@original_server.tool()def tool_a() -> str:return "A"diff --git a/docs/servers/tools.mdx b/docs/servers/tools.mdxindex 00fa13252..6b1a54356 100644--- a/docs/servers/tools.mdx+++ b/docs/servers/tools.mdx@@ -31,7 +31,7 @@ from fastmcp import FastMCPmcp = FastMCP(name="CalculatorServer")def add(a: int, b: int) -> int:"""Adds two integer numbers together."""return a + b@@ -61,7 +61,7 @@ Type annotations for parameters are essential for proper tool functionality. TheUse standard Python type annotations for parameters:```pythondef analyze_text(text: str,max_tokens: int = 100,@@ -79,7 +79,7 @@ You can provide additional metadata about parameters using Pydantic's `Field` clfrom typing import Annotatedfrom pydantic import Fielddef process_image(image_url: Annotated[str, Field(description="URL of the image to process")],resize: Annotated[bool, Field(description="Whether to resize the image")] = False,@@ -97,7 +97,7 @@ def process_image(You can also use the Field as a default value, though the Annotated approach is preferred:```pythondef search_database(query: str = Field(description="Search query string"),limit: int = Field(10, description="Maximum number of results", ge=1, le=100)@@ -137,7 +137,7 @@ For additional type annotations not listed here, see the [Parameter Types](#paraFastMCP follows Python's standard function parameter conventions. Parameters without default values are required, while those with default values are optional.```pythondef search_products(query: str, # Required - no default valuemax_results: int = 10, # Optional - has default value@@ -197,14 +197,14 @@ FastMCP seamlessly supports both standard (`def`) and asynchronous (`async def`)```python# Synchronous tool (suitable for CPU-bound or quick tasks)def calculate_distance(lat1: float, lon1: float, lat2: float, lon2: float) -> float:"""Calculate the distance between two coordinates."""# Implementation...return 42.5# Asynchronous tool (ideal for I/O-bound operations)async def fetch_weather(city: str) -> dict:"""Retrieve current weather conditions for a city."""# Use 'async def' for operations involving network calls, file I/O, etc.@@ -244,7 +244,7 @@ except ImportError:mcp = FastMCP("Image Demo")def generate_image(width: int, height: int, color: str) -> Image:"""Generates a solid color image."""# Create image using Pillow@@ -258,7 +258,7 @@ def generate_image(width: int, height: int, color: str) -> Image:# Return using FastMCP's Image helperreturn Image(data=img_bytes, format="png")def do_nothing() -> None:"""This tool performs an action but returns no data."""print("Performing a side effect...")@@ -285,7 +285,7 @@ mcp = FastMCP(name="SecureServer", mask_error_details=True)from fastmcp import FastMCPfrom fastmcp.exceptions import ToolErrordef divide(a: float, b: float) -> float:"""Divide a by b."""@@ -351,7 +351,7 @@ from fastmcp import FastMCP, Contextmcp = FastMCP(name="ContextDemo")async def process_data(data_uri: str, ctx: Context) -> dict:"""Process data from a resource with progress reporting."""await ctx.info(f"Processing data from {data_uri}")@@ -396,7 +396,7 @@ FastMCP supports **type coercion** when possible. This means that if a client seThe most common parameter types are Python's built-in scalar types:```pythondef process_values(name: str, # Text datacount: int, # Integer numbers@@ -416,7 +416,7 @@ FastMCP supports various date and time types from the `datetime` module:```pythonfrom datetime import datetime, date, timedeltadef process_date_time(event_date: date, # ISO format date string or date objectevent_time: datetime, # ISO format datetime string or datetime object@@ -440,7 +440,7 @@ def process_date_time(FastMCP supports all standard Python collection types:```pythondef analyze_data(values: list[float], # List of numbersproperties: dict[str, str], # Dictionary with string keys and values@@ -465,7 +465,7 @@ Collection types can be nested and combined to represent complex data structuresFor parameters that can accept multiple types or may be omitted:```pythondef flexible_search(query: str | int, # Can be either string or integerfilters: dict[str, str] | None = None, # Optional dictionary@@ -488,7 +488,7 @@ Literals constrain parameters to a specific set of values:```pythonfrom typing import Literaldef sort_data(data: list[float],order: Literal["ascending", "descending"] = "ascending",@@ -516,7 +516,7 @@ class Color(Enum):GREEN = "green"BLUE = "blue"def process_image(image_path: str,color_filter: Color = Color.RED@@ -539,7 +539,7 @@ There are two approaches to handling binary data in tool parameters:#### Bytes```pythondef process_binary(data: bytes):"""Process binary data directly.@@ -563,7 +563,7 @@ FastMCP does not automatically decode base64-encoded strings for bytes parameterfrom typing import Annotatedfrom pydantic import Fielddef process_image_data(image_data: Annotated[str, Field(description="Base64-encoded image data")]):@@ -587,7 +587,7 @@ The `Path` type from the `pathlib` module can be used for file system paths:```pythonfrom pathlib import Pathdef process_file(path: Path) -> str:"""Process a file at the given path."""assert isinstance(path, Path) # Path is properly converted@@ -603,7 +603,7 @@ The `UUID` type from the `uuid` module can be used for unique identifiers:```pythonimport uuiddef process_item(item_id: uuid.UUID # String UUID or UUID object) -> str:@@ -628,7 +628,7 @@ class User(BaseModel):age: int | None = Noneis_active: bool = Truedef create_user(user: User):"""Create a new user in the system."""# The input is automatically validated against the User model@@ -657,7 +657,7 @@ Note that fields can be used *outside* Pydantic models to provide metadata and vfrom typing import Annotatedfrom pydantic import Fielddef analyze_metrics(# Numbers with range constraintscount: Annotated[int, Field(ge=0, le=100)], # 0 <= count <= 100@@ -682,7 +682,7 @@ def analyze_metrics(You can also use `Field` as a default value, though the `Annotated` approach is preferred:```pythondef validate_data(# Value constraintsage: int = Field(ge=0, lt=120), # 0 <= age < 120@@ -727,7 +727,7 @@ mcp = FastMCP(on_duplicate_tools="error")def my_tool(): return "Version 1"# This will now raise a ValueError because 'my_tool' already exists@@ -754,7 +754,7 @@ from fastmcp import FastMCPmcp = FastMCP(name="DynamicToolServer")def calculate_sum(a: int, b: int) -> int:"""Add two numbers together."""return a + b