JinDaGe - prefect-mcp-server MCP Details

article

README

🚀 预制 MCP 服务器

此仓库提供了一个 Prefect MCP 服务器配置，使用 prefect-mcp-server 包，并通过 uvx 实现可靠的运行机制。该配置专为与 Cursor IDE 配合使用而设计，能为开发工作带来便利。

🚀 快速开始

本配置适用于与 Cursor IDE 配合使用的 Prefect MCP 服务器。按照以下步骤操作，即可快速搭建并启动服务器。

✨ 主要特性

专为与 Cursor IDE 配合使用而设计。
通过 uvx 实现可靠的运行机制。
提供增强的可靠性和一致性，确保与安装的确切包版本一起使用。

📦 安装指南

先决条件

Python 3.9 或更高版本。
偏好的虚拟环境工具（如 uv）用于管理 Python 环境。
Prefect 3（请参阅 Prefect 文档获取安装说明）。

安装步骤

创建并激活您的虚拟环境，然后安装 Prefect MCP 服务器：

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

🔧 配置说明

服务器配置

服务器通过 .cursor/mcp.json 文件进行配置。更新后的配置如下：

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

此配置确保服务器使用 uvx 命令，并与通过 uv pip install 安装的确切包版本一起使用，为开发环境提供增强的可靠性和一致性。

环境变量配置

设置以下环境变量以配置您的 Prefect 环境。您可以在项目根目录中创建一个名为 .env 的文件，其中包含如下条目：

PREFECT_API_URL=http://localhost:4200/api

此外，如果需要，设置其他环境变量如 PREFECT_API_KEY 以与您的 Prefect 服务器或 Prefect Cloud 进行身份验证。

💻 使用示例

启动服务器

要启动服务器，可以运行以下命令：

uv run <script>

或者，如果您使用的是 Cursor IDE 并已配置其设置，则服务器将自动调用 .cursor/mcp.json 中指定的命令。

📚 详细文档

在 docs/prefect_mcp_documentation.md 文件中提供了关于 Prefect MCP 服务器功能和使用的详细文档。文档内容包括：

完整的工具列表及其参数
安装和配置说明
使用不同 MCP 客户端的示例
Prefect 3.0 兼容性信息

🔖 Cursor 规则

此仓库包含用于与 Prefect MCP 服务器一起工作的 Cursor 规则，位于 .cursor/rules/ 目录中。这些规则为在 Cursor IDE 中使用 Prefect MCP 提供上下文帮助和指导。

📎 额外信息

关于 Prefect 安装和使用的更多信息，请参阅 Prefect 文档。
有关模型上下文协议（MCP）的详细信息，请访问 MCP 文档。
使用 uv run 在推荐的环境中运行脚本，如 Cursor 所建议。

祝您编码愉快！

prefect-mcp-server