Skip to main content
Glama
Prefect MCP Server

Prefect MCP Server

by fortunto2

Prefect MCP Server

This repository provides a Prefect MCP server configuration using the prefect-mcp-server package with a reliable running mechanism via uvx. The configuration is tailored for use with the Cursor IDE.

Prerequisites

  • Python 3.9 or newer.

  • A preferred virtual environment tool (such as uv) for managing Python environments.

  • Prefect 3 (see Prefect Documentation for installation instructions).

Related MCP server: MCP Prompt Server

Installation

Create and activate your virtual environment, then install Prefect MCP Server:

uv venv --python 3.12 && source .venv/bin/activate
uv pip install -U prefect-mcp-server

Configuration

The server is configured via the .cursor/mcp.json file. The updated configuration is as follows:

{
  "mcpServers": {
    "prefect": {
      "command": "uvx",
      "args": [
        "prefect-mcp-server"
      ],
      "env": {}
    }
  }
}

This configuration ensures that the server uses the uvx command with the exact package version installed via uv pip install. This approach provides enhanced reliability and consistency in your development environment.

Environment Variables

Set the following environment variables to configure your Prefect environment. You can create a file named .env in the project root with entries such as:

PREFECT_API_URL=http://localhost:4200/api

Additionally, if needed, set other environment variables like PREFECT_API_KEY to authenticate with your Prefect server or Prefect Cloud.

Running the Server

To start the server, you can run the following command:

uv run <script>

Alternatively, if you are using the Cursor IDE with its configuration, the server will be automatically invoked with the command specified in .cursor/mcp.json.

Documentation

Detailed documentation on the Prefect MCP Server functionality and usage is available in the docs/prefect_mcp_documentation.md file. The documentation includes:

  • Complete list of available tools and their parameters

  • Instructions for installation and configuration

  • Examples of usage with different MCP clients

  • Prefect 3.0 compatibility information

Cursor Rules

This repository includes Cursor Rules for working with the Prefect MCP Server, located in the .cursor/rules/ directory. These rules provide contextual help and guidance when working with Prefect MCP in the Cursor IDE.

Additional Information

  • For further details on Prefect installation and usage, please refer to the Prefect Documentation.

  • For information about the Model Context Protocol (MCP), see the MCP Documentation.

  • Use uv run for running scripts within the configured environment as recommended by Cursor.

Happy coding!

Available Tools

17 tools
cancel_flow_runB

Cancel a flow run.

Args:
    flow_run_id: ID of the flow run to cancel.

Inputs: flow_run_id (required). Returns: result

create_flow_runB

Create a new flow run for the specified deployment (Legacy).

Args:
    deployment_id: ID of the deployment to create a run for.
    parameters: Dictionary with parameters for the flow run (optional).

Inputs: deployment_id (required), parameters. Returns: result

create_flow_run_from_deploymentB

Create a new flow run for the specified deployment.

Args:
    deployment_id: ID of the deployment or name in format 'flow_name/deployment_name'.
    parameters: Dictionary with parameters for the flow run (optional).
    name: Optional name for the flow run.
    timeout: Timeout in seconds, 0 means no waiting for completion (default 0).

Inputs: deployment_id (required), parameters, name, timeout. Returns: result

filter_deploymentsB

Filter deployments based on specified criteria.

Args:
    filter_criteria: Dictionary with filter criteria according to Prefect API.
                     Example1: {"deployments": {"is_schedule_active": {"eq_": true}}}
                     Example2: {"deployments": {"tags": {"all_": ["production"]}}}

Inputs: filter_criteria (required). Returns: result

filter_flow_runsC

Filter flow runs based on specified criteria.

Args:
    filter_criteria: Dictionary with filter criteria according to Prefect API.
                     Example: {"flow_runs": {"state": {"type": {"any_": ["FAILED", "CRASHED"]}}}}

Inputs: filter_criteria (required). Returns: result

filter_flowsB

Filter flows based on specified criteria.

Args:
    filter_criteria: Dictionary with filter criteria according to Prefect API.
                     Example: {"flows": {"tags": {"all_": ["production"]}}}

Inputs: filter_criteria (required). Returns: result

get_deployment_by_idB

Get a deployment by its ID.

Args:
    deployment_id: ID of the deployment to retrieve.

Inputs: deployment_id (required). Returns: result

get_deployment_by_nameB

Get a deployment by its name.

Args:
    name: Name of the deployment to retrieve, in format "flow_name/deployment_name".

Inputs: name (required). Returns: result

get_flow_by_idB

Get a flow by its ID.

Args:
    flow_id: ID of the flow to retrieve.

Inputs: flow_id (required). Returns: result

get_flow_by_nameC

Get a flow by its name.

Args:
    name: Name of the flow to retrieve.

Inputs: name (required). Returns: result

get_flow_run_by_idB

Get a flow run by its ID.

Args:
    flow_run_id: ID of the flow run to retrieve.

Inputs: flow_run_id (required). Returns: result

list_deploymentsB

Get a list of deployments from the Prefect API.

Args:
    limit: Maximum number of deployments to return (default 20).
    offset: Number of deployments to skip (default 0).
    flow_id: Optional ID of the flow to filter deployments by.

Inputs: limit, offset, flow_id. Returns: result

list_flow_runsB

Get a list of flow runs from the Prefect API.

Args:
    limit: Maximum number of flow runs to return (default 20).
    offset: Number of flow runs to skip (default 0).
    flow_id: Optional ID of the flow to filter runs by.

Inputs: limit, offset, flow_id. Returns: result

list_flowsB

Get a list of flows from the Prefect API.

Args:
    limit: Maximum number of flows to return (default 20).
    offset: Number of flows to skip (default 0).

Inputs: limit, offset. Returns: result

search_deployments_by_statusB

Search for deployments by schedule status.

Args:
    is_schedule_active: Filter deployments by whether their schedule is active.
    limit: Maximum number of deployments to return (default 20).

Inputs: is_schedule_active, limit. Returns: result

search_flow_runs_by_stateB

Search for flow runs by state.

Args:
    state_type: Optional state type (e.g., "COMPLETED", "FAILED", "CRASHED").
    state_name: Optional state name (e.g., "Completed", "Failed").
    limit: Maximum number of flow runs to return (default 20).

Inputs: state_type, state_name, limit. Returns: result

search_flowsA

Search for flows by name and/or tags.

Args:
    name: Optional name to search for (case-insensitive contains match).
    tags: Optional list of tags to filter by.
    limit: Maximum number of flows to return (default 20).

Inputs: name, tags, limit. Returns: result

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.5/5.0

    Scored across 17 tools

    Disambiguation4/5

    Most tools have distinct purposes targeting specific resources (flows, deployments, flow runs) with clear action verbs, but there is some overlap between filter_* and search_* tools that could cause confusion. For example, filter_deployments and search_deployments_by_status both filter deployments but use different approaches, and create_flow_run vs create_flow_run_from_deployment are similar with minor differences.

    Naming Consistency5/5

    Tool names follow a highly consistent verb_noun pattern throughout, with clear conventions like get_*, list_*, create_*, filter_*, search_*, and cancel_*. All names use snake_case uniformly, making them predictable and easy to parse for an agent.

    Tool Count4/5

    With 17 tools, the count is slightly high but reasonable for a workflow orchestration domain like Prefect, which requires operations across flows, deployments, and runs. It covers essential CRUD and query functions without being overwhelmingly bloated, though some tools could potentially be consolidated.

    Completeness5/5

    The tool set provides comprehensive coverage for managing Prefect workflows, including full CRUD/lifecycle operations for flows, deployments, and flow runs (e.g., create, get, list, filter, search, cancel). There are no obvious gaps that would hinder an agent from performing typical orchestration tasks, and the surface supports complex filtering and searching needs.

    Maintenance

    ActivityInactive
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers