MCP Prefect

🚀 預製 MCP 服務器

預製 MCP 服務器是 Prefect 的一個 Model Context Protocol (MCP) 服務器實現，它允許 AI 助手通過自然語言與 Prefect 進行交互，為用戶提供了更加便捷的操作體驗。

🚀 快速開始

配置

設置以下環境變量：

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

運行

運行 MCP 服務器和 prefect：

docker compose up

✨ 主要特性

此 MCP 服務器提供了以下 Prefect API 的訪問權限：

• 流管理：列出、獲取和刪除流
• 流程運行管理：創建、監控和控制流程運行
• 部署管理：管理和安排部署
• 任務運行管理：監控和控制任務運行
• 工作隊列管理：創建和管理工作隊列
• 塊管理：訪問塊類型和文檔
• 變量管理：創建和管理變量
• 工作區管理：獲取有關工作區的信息

💻 使用示例

基礎用法

一旦連接，AI 助手可以使用自然語言幫助用戶與 Prefect 交互。示例包括：

• "顯示所有我的流"
• "列出昨天所有失敗的流程運行"
• "觸發 'data-processing' 部署"
• "暫停 'daily-reporting' 部署的時間表"
• "我上次 ETL 流程運行的狀態如何？"

高級用法

開發配置示例

{
  "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 類型