Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| PREFECT_API_KEY | No | Your Prefect API key (if using Prefect Cloud) | |
| PREFECT_API_URL | Yes | URL of your Prefect API | http://localhost:4200/api |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_flows | Get a list of flows with optional filtering. Args: limit: Maximum number of flows to return offset: Number of flows to skip flow_name: Filter flows by name tags: Filter flows by tags created_after: ISO formatted datetime string for filtering flows created after this time created_before: ISO formatted datetime string for filtering flows created before this time Returns: A list of flows with their details |
| get_flow | Get details of a specific flow by ID. Args: flow_id: The flow UUID Returns: Flow details |
| delete_flow | Delete a flow by ID. Args: flow_id: The flow UUID Returns: Confirmation message |
| get_flow_runs | Get a list of flow runs with optional filtering. Args: limit: Maximum number of flow runs to return offset: Number of flow runs to skip flow_name: Filter by flow name state_type: Filter by state type (e.g., "RUNNING", "COMPLETED", "FAILED") state_name: Filter by state name deployment_id: Filter by deployment ID tags: Filter by tags start_time_before: ISO formatted datetime string start_time_after: ISO formatted datetime string Returns: A list of flow runs with their details |
| get_flow_run | Get details of a specific flow run by ID. Args: flow_run_id: The flow run UUID Returns: Flow run details |
| get_flow_runs_by_flow | Get flow runs for a specific flow. Args: flow_id: The flow UUID limit: Maximum number of flow runs to return offset: Number of flow runs to skip state_type: Filter by state type (e.g., "RUNNING", "COMPLETED", "FAILED") Returns: A list of flow runs for the specified flow |
| restart_flow_run | Restart a flow run. Args: flow_run_id: The flow run UUID Returns: Details of the new flow run |
| cancel_flow_run | Cancel a flow run. Args: flow_run_id: The flow run UUID Returns: Confirmation message |
| delete_flow_run | Delete a flow run. Args: flow_run_id: The flow run UUID Returns: Confirmation message |
| set_flow_run_state | Set a flow run's state. Args: flow_run_id: The flow run UUID state: The new state to set (e.g., "SCHEDULED", "RUNNING", "COMPLETED", "FAILED") message: An optional message explaining the state change Returns: Result of the state change operation |
| get_deployments | Get a list of deployments with optional filtering. Args: limit: Maximum number of deployments to return offset: Number of deployments to skip flow_name: Filter by flow name name: Filter by deployment name tags: Filter by tags is_schedule_active: Filter by schedule active status work_queue_name: Filter by work queue name Returns: A list of deployments with their details |
| get_deployment | Get details of a specific deployment by ID. Args: deployment_id: The deployment UUID Returns: Deployment details |
| create_flow_run_from_deployment | Create a flow run from a deployment. Args: deployment_id: The deployment UUID parameters: Optional parameters to pass to the flow run name: Optional name for the flow run tags: Optional tags for the flow run idempotency_key: Optional idempotency key Returns: Details of the created flow run |
| delete_deployment | Delete a deployment by ID. Args: deployment_id: The deployment UUID Returns: Confirmation message |
| update_deployment | Update a deployment. Args: deployment_id: The deployment UUID name: New name for the deployment description: New description version: New version tags: New tags parameters: New parameters work_queue_name: New work queue name Returns: Details of the updated deployment |
| get_deployment_schedule | Get a deployment's schedule. Args: deployment_id: The deployment UUID Returns: Schedule details |
| set_deployment_schedule | Set a deployment's schedule. Args: deployment_id: The deployment UUID cron: Cron expression for the schedule interval_seconds: Alternative to cron - interval in seconds anchor_date: Required for interval schedules - the anchor date timezone: Timezone for the schedule Returns: Updated schedule details |
| pause_deployment_schedule | Pause a deployment's schedule. Args: deployment_id: The deployment UUID Returns: Confirmation message |
| resume_deployment_schedule | Resume a deployment's schedule. Args: deployment_id: The deployment UUID Returns: Confirmation message |
| get_task_runs | Get a list of task runs with optional filtering. Args: limit: Maximum number of task runs to return offset: Number of task runs to skip task_name: Filter by task name state_type: Filter by state type (e.g., "RUNNING", "COMPLETED", "FAILED") state_name: Filter by state name tags: Filter by tags start_time_before: ISO formatted datetime string start_time_after: ISO formatted datetime string Returns: A list of task runs with their details |
| get_task_run | Get details of a specific task run by ID. Args: task_run_id: The task run UUID Returns: Task run details |
| get_task_runs_by_flow_run | Get task runs for a specific flow run. Args: flow_run_id: The flow run UUID limit: Maximum number of task runs to return offset: Number of task runs to skip state_type: Filter by state type (e.g., "RUNNING", "COMPLETED", "FAILED") Returns: A list of task runs for the specified flow run |
| set_task_run_state | Set a task run's state. Args: task_run_id: The task run UUID state: The new state to set (e.g., "SCHEDULED", "RUNNING", "COMPLETED", "FAILED") message: An optional message explaining the state change Returns: Result of the state change operation |
| get_workspaces | Get a list of accessible workspaces. Args: limit: Maximum number of workspaces to return offset: Number of workspaces to skip name: Filter workspaces by name (note: filtering may not be supported by all Prefect versions) Returns: A list of workspaces with their details |
| get_current_workspace | Get the current workspace. Returns: Details of the current workspace |
| get_workspace | Get a workspace by ID. Args: workspace_id: The workspace UUID Returns: Workspace details |
| get_workspace_by_handle | Get a workspace by its handle. Args: account_handle: The account handle workspace_handle: The workspace handle Returns: Workspace details |
| get_block_types | Get a list of block types with optional filtering. Args: limit: Maximum number of block types to return offset: Number of block types to skip slug: Filter by slug pattern Returns: A list of block types with their details |
| get_block_type | Get a block type by slug. Args: slug: The block type slug Returns: Block type details |
| get_block_documents | Get block documents by block type. Args: block_type_slug: The block type slug limit: Maximum number of block documents to return offset: Number of block documents to skip name: Filter by name pattern Returns: A list of block documents with their details |
| get_block_document | Get a block document by ID. Args: block_document_id: The block document UUID Returns: Block document details |
| delete_block_document | Delete a block document by ID. Args: block_document_id: The block document UUID Returns: Confirmation message |
| get_variables | Get a list of variables with optional filtering. Args: limit: Maximum number of variables to return offset: Number of variables to skip name: Filter by name pattern Returns: A list of variables with their details |
| get_variable | Get a variable by name. Args: name: The variable name Returns: Variable details |
| create_variable | Create a variable. Args: name: The variable name value: The variable value (can be string, dict, list, etc.) tags: Optional tags Returns: Details of the created variable |
| update_variable | Update a variable. Args: name: The variable name value: New value tags: New tags Returns: Details of the updated variable |
| delete_variable | Delete a variable by name. Args: name: The variable name Returns: Confirmation message |
| get_work_queues | Get a list of work queues with optional filtering. Args: limit: Maximum number of work queues to return offset: Number of work queues to skip name: Filter by name is_paused: Filter by paused status Returns: A list of work queues with their details |
| get_work_queue | Get details of a specific work queue by ID. Args: work_queue_id: The work queue UUID Returns: Work queue details |
| get_work_queue_by_name | Get a work queue by name. Args: name: The work queue name Returns: Work queue details |
| create_work_queue | Create a work queue. Args: name: The name for the work queue description: Optional description is_paused: Whether the queue should be paused upon creation concurrency_limit: Optional concurrency limit Returns: Details of the created work queue |
| update_work_queue | Update a work queue. Args: work_queue_id: The work queue UUID name: New name description: New description is_paused: New paused status concurrency_limit: New concurrency limit Returns: Details of the updated work queue |
| delete_work_queue | Delete a work queue by ID. Args: work_queue_id: The work queue UUID Returns: Confirmation message |
| pause_work_queue | Pause a work queue. Args: work_queue_id: The work queue UUID Returns: Details of the updated work queue |
| resume_work_queue | Resume a work queue. Args: work_queue_id: The work queue UUID Returns: Details of the updated work queue |
| get_health | Get health status of the Prefect server. Returns: Health status information |