mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-23 05:54:19 +02:00
chore: Update SDK documentation (#2517)
Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>
This commit is contained in:
parent
080ffa578a
commit
d35b867b10
36 changed files with 1740 additions and 416 deletions
41
docs/python-sdk/fastmcp-cli-tasks.mdx
Normal file
41
docs/python-sdk/fastmcp-cli-tasks.mdx
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: tasks
|
||||
sidebarTitle: tasks
|
||||
---
|
||||
|
||||
# `fastmcp.cli.tasks`
|
||||
|
||||
|
||||
FastMCP tasks CLI for Docket task management.
|
||||
|
||||
## Functions
|
||||
|
||||
### `check_distributed_backend` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/tasks.py#L22" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
||||
|
||||
```python
|
||||
check_distributed_backend() -> None
|
||||
```
|
||||
|
||||
|
||||
Check if Docket is configured with a distributed backend.
|
||||
|
||||
The CLI worker runs as a separate process, so it needs Redis/Valkey
|
||||
to coordinate with the main server process.
|
||||
|
||||
**Raises:**
|
||||
- `SystemExit`: If using memory\:// URL
|
||||
|
||||
|
||||
### `worker` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/tasks.py#L61" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
||||
|
||||
```python
|
||||
worker(server_spec: Annotated[str | None, cyclopts.Parameter(help='Python file to run, optionally with :object suffix, or None to auto-detect fastmcp.json')] = None) -> None
|
||||
```
|
||||
|
||||
|
||||
Start an additional worker to process background tasks.
|
||||
|
||||
Connects to your Docket backend and processes tasks in parallel with
|
||||
any other running workers. Configure via environment variables
|
||||
(FASTMCP_DOCKET_*).
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue