Prefect MCP Server

🚀 Prefabricated MCP Server

This repository provides a Prefect MCP server configuration that uses the prefect-mcp-server package and implements a reliable operation mechanism through uvx. This configuration is specifically designed for use with the Cursor IDE.

🚀 Quick Start

✨ Features

This configuration offers a reliable and consistent way to run the Prefect MCP server, especially tailored for use with the Cursor IDE. It ensures that the server uses the uvx command and the exact package version installed via uv pip install, enhancing the reliability and consistency of your development environment.

📦 Installation

• Prerequisites:
  • Python 3.9 or higher.
  • A preferred virtual environment tool (e.g., uv) for managing Python environments.
  • Prefect 3 (see Prefect documentation for installation instructions).

To install the Prefect MCP server, create and activate your virtual environment, then run the following commands:

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

🔧 Configuration

The server is configured through 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 and the exact package version installed via uv pip install, providing enhanced reliability and consistency for 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 directory with the following entry:

PREFECT_API_URL=http://localhost:4200/api

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

💻 Starting the Server

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

uv run <script>

Alternatively, if you are using the Cursor IDE and have configured its settings, the server will automatically call the command specified in .cursor/mcp.json.

📚 Documentation

Detailed documentation on the features and usage of the Prefect MCP server is provided in the docs/prefect_mcp_documentation.md file. The documentation includes:

• A complete list of tools and their parameters
• Installation and configuration instructions
• Examples of using different MCP clients
• Compatibility information for Prefect 3.0

📄 Cursor Rules

This repository contains Cursor rules for working with the Prefect MCP server, located in the .cursor/rules/ directory. These rules provide context help and guidance for using Prefect MCP in the Cursor IDE.

📄 Additional Information

• For more information on Prefect installation and usage, refer to the Prefect documentation.
• For detailed information on the Model Context Protocol (MCP), visit the MCP documentation.
• Use uv run to run scripts in the recommended environment, as suggested by Cursor.

Happy coding!