MCP Prefect

🚀 预制 MCP 服务器

本项目是 Prefect 的一个 Model Context Protocol (MCP) 服务器实现，它能让 AI 助手借助自然语言与 Prefect 进行交互，为用户提供更便捷的操作体验。

🚀 快速开始

运行 MCP 服务器和 prefect，只需执行以下命令：

docker compose up

✨ 主要特性

此 MCP 服务器提供了对以下 Prefect API 的访问权限：

• 流管理：可列出、获取和删除流。
• 流程运行管理：能够创建、监控和控制流程运行。
• 部署管理：实现管理和安排部署的功能。
• 任务运行管理：用于监控和控制任务运行。
• 工作队列管理：支持创建和管理工作队列。
• 块管理：可访问块类型和文档。
• 变量管理：能够创建和管理变量。
• 工作区管理：可获取有关工作区的信息。

📦 安装指南

设置以下环境变量：

export PREFECT_API_URL="http://localhost:4200/api"  # 您的 Prefect API 的 URL
export PREFECT_API_KEY="your_api_key"               # 您的 Prefect API 密钥（如果使用的是 Prefect Cloud）

💻 使用示例

基础用法

一旦连接，AI 助手可以使用自然语言帮助用户与 Prefect 交互。示例如下：

• "显示所有我的流"
• "列出昨天所有失败的流程运行"
• "触发 'data-processing' 部署"
• "暂停 'daily-reporting' 部署的时间表"
• "我上次 ETL 流程运行的状态如何？"

高级用法

以下是添加新功能或新 API 类型时的配置示例：

{
  "mcpServers": {
    "mcp-prefect": {
      "command": "mcp-prefect",
      "args": [
        "--transport", "sse"
      ],
      "env": {
        "PYTHONPATH": "/path/to/your/project/directory"
      },
      "cwd": "/path/to/your/project/directory"
    }
  }
}

🔧 技术细节

开发说明

目前，一些端点尚未实现。

添加新功能

若要向现有 API 添加新功能，可按以下步骤操作：

1. 将函数添加到 src/mcp_prefect 目录下相应的模块中。
2. 将函数添加到该模块的 get_all_functions() 列表中。

若要添加新的 API 类型，可按以下步骤操作：

1. 向 APIType 添加新的类型（在 enums.py 中）。
2. 在 src/prefect/ 目录下创建新的模块。
3. 更新 main.py 以包含新的 API 类型。