Hiveflow MCP Server

🚀 @hiveflow/mcp-server

這是 HiveFlow 官方的模型上下文協議（MCP）服務器。藉助它，你可以將 AI 助手（如 Claude、Cursor 等）直接連接到 HiveFlow 自動化平臺。

🚀 快速開始

📦 安裝指南

npm install -g @hiveflow/mcp-server

配置

將以下內容添加到你的 MCP 客戶端配置文件（例如 .cursor/mcp.json）中：

{
  "mcpServers": {
    "hiveflow": {
      "command": "npx",
      "args": ["-y", "@hiveflow/mcp-server"],
      "env": {
        "HIVEFLOW_API_KEY": "your-api-key-here",
        "HIVEFLOW_API_URL": "https://api.hiveflow.ai"
      }
    }
  }
}

本地開發配置

{
  "mcpServers": {
    "hiveflow": {
      "command": "npx",
      "args": ["-y", "@hiveflow/mcp-server"],
      "env": {
        "HIVEFLOW_API_KEY": "your-api-key-here",
        "HIVEFLOW_API_URL": "http://localhost:5000"
      }
    }
  }
}

🔑 獲取 API 密鑰

選項 1：從 HiveFlow 控制檯獲取

1. 登錄你的 HiveFlow 控制檯。
2. 進入“設置”>“API 密鑰”。
3. 生成一個新的 API 密鑰。

選項 2：通過命令行獲取（自託管）

cd your-hiveflow-backend
node get-api-key.js your-email@example.com

🛠️ 可用工具

配置完成後，你可以在 AI 助手中使用以下工具：

流程管理

• create_flow - 創建新的自動化流程。
• list_flows - 列出所有流程。
• get_flow - 獲取特定流程的詳細信息。
• execute_flow - 執行流程，並可選擇傳入輸入參數。
• pause_flow - 暫停正在運行的流程。
• resume_flow - 恢復已暫停的流程。
• get_flow_executions - 獲取流程執行歷史記錄。

MCP 服務器管理

• list_mcp_servers - 列出已配置的 MCP 服務器。
• create_mcp_server - 註冊新的 MCP 服務器。

📊 可用資源

• hiveflow://flows - 訪問所有流程數據。
• hiveflow://mcp-servers - 訪問 MCP 服務器配置。
• hiveflow://executions - 訪問流程執行歷史記錄。

💻 使用示例

基礎用法

創建新流程

AI: "Create a flow called 'Email Processor' that analyzes incoming emails"

列出活躍流程

AI: "Show me all my active flows"

執行流程

AI: "Execute the flow with ID 'abc123' with input data {email: 'test@example.com'}"

獲取流程狀態

AI: "What's the status of my Email Processor flow?"

🔧 配置選項

環境變量

• HIVEFLOW_API_KEY - 你的 HiveFlow API 密鑰（必需）。
• HIVEFLOW_API_URL - 你的 HiveFlow 實例 URL（默認值：https://api.hiveflow.ai）。
• HIVEFLOW_INSTANCE_ID - 多租戶設置中的實例 ID（可選）。

命令行選項

hiveflow-mcp --api-key YOUR_KEY --api-url https://your-instance.com

🏗️ 架構

此 MCP 服務器在你的 AI 助手和 HiveFlow 之間充當橋樑：

AI Assistant (Claude/Cursor) ↔ MCP Server ↔ HiveFlow API

🔒 安全性

• API 密鑰通過 HTTPS 安全傳輸。
• 所有請求都經過身份驗證和授權。
• MCP 服務器不會在本地存儲任何數據。

🐛 故障排除

常見問題

“HIVEFLOW_API_KEY is required”

• 確保你已在 MCP 配置中設置了 API 密鑰。
• 驗證 API 密鑰是否有效且未過期。

“Cannot connect to HiveFlow API”

• 檢查你的 HiveFlow 實例是否正在運行。
• 驗證 API URL 是否正確。
• 確保沒有防火牆限制。

“MCP server not found”

• 完全重啟你的 AI 助手。
• 驗證 MCP 配置文件是否位於正確的位置。
• 檢查包是否已安裝：npm list -g @hiveflow/mcp-server。

調試模式

若要查看詳細日誌，請設置以下環境變量：

export DEBUG=hiveflow-mcp:*

📚 詳細文檔

• HiveFlow 文檔
• MCP 協議規範
• API 參考

🤝 貢獻

我們歡迎大家貢獻代碼！請查看 貢獻指南 瞭解詳細信息。

📄 許可證

本項目採用 MIT 許可證，詳情請參閱 LICENSE 文件。

🆘 支持

• GitHub 問題
• Discord 社區
• 郵件支持

由 HiveFlow 團隊用心打造 ❤️