mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-29 18:52:07 +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)
267 lines
7.4 KiB
Text
267 lines
7.4 KiB
Text
---
|
|
title: Client Transports
|
|
sidebarTitle: Transports
|
|
description: Configure how clients connect to and communicate with MCP servers.
|
|
icon: link
|
|
---
|
|
|
|
import { VersionBadge } from "/snippets/version-badge.mdx"
|
|
|
|
<VersionBadge version="2.0.0" />
|
|
|
|
Transports handle the underlying connection between your client and MCP servers. While the client can automatically select a transport based on what you pass to it, instantiating transports explicitly gives you full control over configuration.
|
|
|
|
## STDIO Transport
|
|
|
|
STDIO transport communicates with MCP servers through subprocess pipes. When using STDIO, your client launches and manages the server process, controlling its lifecycle and environment.
|
|
|
|
<Warning>
|
|
STDIO servers run in isolated environments by default. They do not inherit your shell's environment variables. You must explicitly pass any configuration the server needs.
|
|
</Warning>
|
|
|
|
```python
|
|
from fastmcp import Client
|
|
from fastmcp.client.transports import StdioTransport
|
|
|
|
transport = StdioTransport(
|
|
command="python",
|
|
args=["my_server.py", "--verbose"],
|
|
env={"API_KEY": "secret", "LOG_LEVEL": "DEBUG"},
|
|
cwd="/path/to/server"
|
|
)
|
|
client = Client(transport)
|
|
```
|
|
|
|
For convenience, the client can infer STDIO transport from file paths, though this limits configuration options:
|
|
|
|
```python
|
|
from fastmcp import Client
|
|
|
|
client = Client("my_server.py") # Limited - no configuration options
|
|
```
|
|
|
|
### Environment Variables
|
|
|
|
Since STDIO servers do not inherit your environment, you need strategies for passing configuration.
|
|
|
|
**Selective forwarding** passes only the variables your server needs:
|
|
|
|
```python
|
|
import os
|
|
from fastmcp.client.transports import StdioTransport
|
|
|
|
required_vars = ["API_KEY", "DATABASE_URL", "REDIS_HOST"]
|
|
env = {var: os.environ[var] for var in required_vars if var in os.environ}
|
|
|
|
transport = StdioTransport(command="python", args=["server.py"], env=env)
|
|
client = Client(transport)
|
|
```
|
|
|
|
**Loading from .env files** keeps configuration separate from code:
|
|
|
|
```python
|
|
from dotenv import dotenv_values
|
|
from fastmcp.client.transports import StdioTransport
|
|
|
|
env = dotenv_values(".env")
|
|
transport = StdioTransport(command="python", args=["server.py"], env=env)
|
|
client = Client(transport)
|
|
```
|
|
|
|
### Session Persistence
|
|
|
|
STDIO transports maintain sessions across multiple client contexts by default (`keep_alive=True`). This reuses the same subprocess for multiple connections, improving performance.
|
|
|
|
```python
|
|
from fastmcp.client.transports import StdioTransport
|
|
|
|
transport = StdioTransport(command="python", args=["server.py"])
|
|
client = Client(transport)
|
|
|
|
async def efficient_multiple_operations():
|
|
async with client:
|
|
await client.ping()
|
|
|
|
async with client: # Reuses the same subprocess
|
|
await client.call_tool("process_data", {"file": "data.csv"})
|
|
```
|
|
|
|
For complete isolation between connections, disable session persistence:
|
|
|
|
```python
|
|
transport = StdioTransport(command="python", args=["server.py"], keep_alive=False)
|
|
```
|
|
|
|
## HTTP Transport
|
|
|
|
<VersionBadge version="2.3.0" />
|
|
|
|
HTTP transport connects to MCP servers running as web services. This is the recommended transport for production deployments.
|
|
|
|
```python
|
|
from fastmcp import Client
|
|
from fastmcp.client.transports import StreamableHttpTransport
|
|
|
|
transport = StreamableHttpTransport(
|
|
url="https://api.example.com/mcp",
|
|
headers={
|
|
"Authorization": "Bearer your-token-here",
|
|
"X-Custom-Header": "value"
|
|
}
|
|
)
|
|
client = Client(transport)
|
|
```
|
|
|
|
FastMCP also provides authentication helpers:
|
|
|
|
```python
|
|
from fastmcp import Client
|
|
from fastmcp.client.auth import BearerAuth
|
|
|
|
client = Client(
|
|
"https://api.example.com/mcp",
|
|
auth=BearerAuth("your-token-here")
|
|
)
|
|
```
|
|
|
|
### SSL Verification
|
|
|
|
By default, HTTPS connections verify the server's SSL certificate. You can customize this behavior with the `verify` parameter, which accepts the same values as [httpx](https://www.python-httpx.org/advanced/ssl/):
|
|
|
|
```python
|
|
from fastmcp import Client
|
|
|
|
# Disable SSL verification (e.g., for self-signed certs in development)
|
|
client = Client("https://dev-server.internal/mcp", verify=False)
|
|
|
|
# Use a custom CA bundle
|
|
client = Client("https://corp-server.internal/mcp", verify="/path/to/ca-bundle.pem")
|
|
|
|
# Use a custom SSL context for full control
|
|
import ssl
|
|
ctx = ssl.create_default_context()
|
|
ctx.load_verify_locations("/path/to/internal-ca.pem")
|
|
client = Client("https://corp-server.internal/mcp", verify=ctx)
|
|
```
|
|
|
|
The `verify` parameter is also available directly on `StreamableHttpTransport` and `SSETransport`:
|
|
|
|
```python
|
|
from fastmcp.client.transports import StreamableHttpTransport
|
|
|
|
transport = StreamableHttpTransport(
|
|
url="https://dev-server.internal/mcp",
|
|
verify=False,
|
|
)
|
|
client = Client(transport)
|
|
```
|
|
|
|
### SSE Transport
|
|
|
|
Server-Sent Events transport is maintained for backward compatibility. Use Streamable HTTP for new deployments unless you have specific infrastructure requirements.
|
|
|
|
```python
|
|
from fastmcp.client.transports import SSETransport
|
|
|
|
transport = SSETransport(
|
|
url="https://api.example.com/sse",
|
|
headers={"Authorization": "Bearer token"}
|
|
)
|
|
client = Client(transport)
|
|
```
|
|
|
|
## In-Memory Transport
|
|
|
|
In-memory transport connects directly to a FastMCP server instance within the same Python process. This eliminates both subprocess management and network overhead, making it ideal for testing.
|
|
|
|
```python
|
|
from fastmcp import FastMCP, Client
|
|
import os
|
|
|
|
mcp = FastMCP("TestServer")
|
|
|
|
@mcp.tool
|
|
def greet(name: str) -> str:
|
|
prefix = os.environ.get("GREETING_PREFIX", "Hello")
|
|
return f"{prefix}, {name}!"
|
|
|
|
client = Client(mcp)
|
|
|
|
async with client:
|
|
result = await client.call_tool("greet", {"name": "World"})
|
|
```
|
|
|
|
<Note>
|
|
Unlike STDIO transports, in-memory servers share the same memory space and environment variables as your client code.
|
|
</Note>
|
|
|
|
## Multi-Server Configuration
|
|
|
|
<VersionBadge version="2.4.0" />
|
|
|
|
Connect to multiple servers defined in a configuration dictionary:
|
|
|
|
```python
|
|
from fastmcp import Client
|
|
|
|
config = {
|
|
"mcpServers": {
|
|
"weather": {
|
|
"url": "https://weather.example.com/mcp",
|
|
"transport": "http"
|
|
},
|
|
"assistant": {
|
|
"command": "python",
|
|
"args": ["./assistant.py"],
|
|
"env": {"LOG_LEVEL": "INFO"}
|
|
}
|
|
}
|
|
}
|
|
|
|
client = Client(config)
|
|
|
|
async with client:
|
|
# Tools are namespaced by server
|
|
weather = await client.call_tool("weather_get_forecast", {"city": "NYC"})
|
|
answer = await client.call_tool("assistant_ask", {"question": "What?"})
|
|
```
|
|
|
|
### Tool Transformations
|
|
|
|
FastMCP supports tool transformations within the configuration. You can change names, descriptions, tags, and arguments for tools from a server.
|
|
|
|
```python
|
|
config = {
|
|
"mcpServers": {
|
|
"weather": {
|
|
"url": "https://weather.example.com/mcp",
|
|
"transport": "http",
|
|
"tools": {
|
|
"weather_get_forecast": {
|
|
"name": "miami_weather",
|
|
"description": "Get the weather for Miami",
|
|
"arguments": {
|
|
"city": {
|
|
"default": "Miami",
|
|
"hide": True,
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
To filter tools by tag, use `include_tags` or `exclude_tags` at the server level:
|
|
|
|
```python
|
|
config = {
|
|
"mcpServers": {
|
|
"weather": {
|
|
"url": "https://weather.example.com/mcp",
|
|
"include_tags": ["forecast"] # Only tools with this tag
|
|
}
|
|
}
|
|
}
|
|
```
|