mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 15:19:10 +02:00
9b248a15b3* Update repository references from jlowin/fastmcp to prefecthq/fastmcp * Retrigger CI after repo transfer * chore: Update SDK documentation * Only run deep triage on bug issues for jlowin --------- Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>
113 lines
3.9 KiB
Text
113 lines
3.9 KiB
Text
---
|
|
title: notifications
|
|
sidebarTitle: notifications
|
|
---
|
|
|
|
# `fastmcp.server.tasks.notifications`
|
|
|
|
|
|
Distributed notification queue for background task events (SEP-1686).
|
|
|
|
Enables distributed Docket workers to send MCP notifications to clients
|
|
without holding session references. Workers push to a Redis queue,
|
|
the MCP server process subscribes and forwards to the client's session.
|
|
|
|
Pattern: Fire-and-forward with retry
|
|
- One queue per session_id
|
|
- LPUSH/BRPOP for reliable ordered delivery
|
|
- Retry up to 3 times on delivery failure, then discard
|
|
- TTL-based expiration for stale messages
|
|
|
|
Note: Docket's execution.subscribe() handles task state/progress events via
|
|
Redis Pub/Sub. This module handles elicitation-specific notifications that
|
|
require reliable delivery (input_required prompts, cancel signals).
|
|
|
|
|
|
## Functions
|
|
|
|
### `push_notification` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/tasks/notifications.py#L48" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
push_notification(session_id: str, notification: dict[str, Any], docket: Docket) -> None
|
|
```
|
|
|
|
|
|
Push notification to session's queue (called from Docket worker).
|
|
|
|
Used for elicitation-specific notifications (input_required, cancel)
|
|
that need reliable delivery across distributed processes.
|
|
|
|
**Args:**
|
|
- `session_id`: Target session's identifier
|
|
- `notification`: MCP notification dict (method, params, _meta)
|
|
- `docket`: Docket instance for Redis access
|
|
|
|
|
|
### `notification_subscriber_loop` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/tasks/notifications.py#L76" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
notification_subscriber_loop(session_id: str, session: ServerSession, docket: Docket, fastmcp: FastMCP) -> None
|
|
```
|
|
|
|
|
|
Subscribe to notification queue and forward to session.
|
|
|
|
Runs in the MCP server process. Bridges distributed workers to clients.
|
|
|
|
This loop:
|
|
1. Maintains a heartbeat (active subscriber marker for debugging)
|
|
2. Blocks on BRPOP waiting for notifications
|
|
3. Forwards notifications to the client's session
|
|
4. Retries failed deliveries, then discards (no dead-letter queue)
|
|
|
|
**Args:**
|
|
- `session_id`: Session identifier to subscribe to
|
|
- `session`: MCP ServerSession for sending notifications
|
|
- `docket`: Docket instance for Redis access
|
|
- `fastmcp`: FastMCP server instance (for elicitation relay)
|
|
|
|
|
|
### `ensure_subscriber_running` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/tasks/notifications.py#L238" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
ensure_subscriber_running(session_id: str, session: ServerSession, docket: Docket, fastmcp: FastMCP) -> None
|
|
```
|
|
|
|
|
|
Start notification subscriber if not already running (idempotent).
|
|
|
|
Subscriber is created on first task submission and cleaned up on disconnect.
|
|
Safe to call multiple times for the same session.
|
|
|
|
**Args:**
|
|
- `session_id`: Session identifier
|
|
- `session`: MCP ServerSession
|
|
- `docket`: Docket instance
|
|
- `fastmcp`: FastMCP server instance (for elicitation relay)
|
|
|
|
|
|
### `stop_subscriber` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/tasks/notifications.py#L278" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
stop_subscriber(session_id: str) -> None
|
|
```
|
|
|
|
|
|
Stop notification subscriber for a session.
|
|
|
|
Called when session disconnects. Pending messages remain in queue
|
|
for delivery if client reconnects (with TTL expiration).
|
|
|
|
**Args:**
|
|
- `session_id`: Session identifier
|
|
|
|
|
|
### `get_subscriber_count` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/server/tasks/notifications.py#L298" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_subscriber_count() -> int
|
|
```
|
|
|
|
|
|
Get number of active subscribers (for monitoring).
|
|
|