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团队用心打造 ❤️