Flux Cloudfare MCP

🚀 Flux Cloudflare MCP

Flux Cloudflare MCP 是一個強大的模型上下文協議（MCP）服務器，它藉助 Cloudflare Worker API，通過 Black Forest Labs 的 Flux 模型 為 AI 助手賦予圖像生成能力。

安裝 • 特性 • 使用方法 • 文檔 • 貢獻代碼

🚀 快速開始

Flux Cloudflare MCP 可讓 AI 助手利用強大的 Flux 模型生成圖像。你可以按照下面的步驟來使用該項目。

✨ 特性

• 🖼️ 高質量圖像生成：能夠使用先進的 Flux 圖像生成模型。
• 🤖 無縫 AI 集成：支持像 Claude 這樣的 AI 助手直接生成圖像。
• 🎛️ 可定製參數：可以控制圖像的寬高比、推理步驟等。
• 🔌 MCP 兼容：可與任何 MCP 客戶端（如 Cursor、Claude Desktop、Cline、Zed 等）配合使用。
• 🔒 本地處理：所有請求都通過 Cloudflare Worker 安全處理。
• 💬 聊天補全：使用相同的 API 獲取文本補全。

📦 安裝

直接使用 NPX

FLUX_API_TOKEN=your_token FLUX_API_URL=your_api_url npx -y flux-cloudflare-mcp

從源代碼安裝

# 克隆倉庫
git clone https://github.com/Hzzy2O/flux-cloudflare-mcp.git
cd flux-cloudflare-mcp

# 安裝依賴
npm install

# 構建項目
npm run build

🚀 設置你的 Flux API

此 MCP 服務器需要一個 Flux API 端點才能正常工作。你可以通過以下兩種方式來設置 API：

選項 1：使用 snakeying/flux-api-worker 部署（推薦）

snakeying/flux-api-worker 提供了一個簡單高效的 Cloudflare Worker 來訪問 Flux 模型：

1. 分叉 flux-api-worker 倉庫。
2. 將其部署到 Cloudflare Workers：
   • 在你的 Cloudflare 控制檯中創建一個新的 Worker。
   • 將其連接到你分叉的倉庫。
   • 設置所需的環境變量：
     • API_KEY：用於身份驗證的 API 密鑰。
     • CF_ACCOUNT_ID：你的 Cloudflare 賬戶 ID。
     • CF_API_TOKEN：具有 Workers AI 訪問權限的 Cloudflare API 令牌。
     • FLUX_MODEL：要使用的 Flux 模型（默認："@cf/black-forest-labs/flux-1-schnell"）。
3. 部署完成後，你的 API 將在 https://your-worker-name.your-subdomain.workers.dev 可用。
4. 使用此 URL 作為 FLUX_API_URL，並將你選擇的 API 密鑰作為 FLUX_API_TOKEN。

選項 2：使用 aigem/cf-flux-remix 部署

如果你需要一個帶有 Web UI 的功能更豐富的實現，可以使用 aigem/cf-flux-remix：

1. 按照 cf-flux-remix 倉庫 中的安裝說明進行操作。
2. 部署完成後，你的 API 將在你部署的 URL 可用。
3. 使用此 URL 作為 FLUX_API_URL，並將你配置的 API 密鑰作為 FLUX_API_TOKEN。

📚 文檔

可用工具

generate_image

使用 Flux 模型根據文本提示生成圖像。

{
  prompt: string;                // 必需：要生成圖像的文本描述
  num_inference_steps?: number;  // 可選：去噪步驟數（1 - 4）（默認：4）
  aspect_ratio?: string;         // 可選：寬高比（例如，"16:9"，"4:3"）（默認："1:1"）
}

🔧 使用方法

Cursor 集成

方法 1：使用 mcp.json

1. 在你的項目目錄中創建或編輯 .cursor/mcp.json 文件：

{
  "mcpServers": {
    "flux-cloudflare-mcp": {
      "command": "env FLUX_API_TOKEN=YOUR_TOKEN FLUX_API_URL=YOUR_API_URL npx",
      "args": ["-y", "flux-cloudflare-mcp"]
    }
  }
}

2. 將 YOUR_TOKEN 替換為你實際的 Flux API 令牌，將 YOUR_API_URL 替換為你的 API URL。
3. 重啟 Cursor 以應用更改。

方法 2：使用 Cursor MCP 設置

1. 打開 Cursor 並進入設置。
2. 導航到“MCP”或“Model Context Protocol”部分。
3. 點擊“添加服務器”或類似選項。
4. 在相應字段中輸入以下命令：

env FLUX_API_TOKEN=YOUR_TOKEN FLUX_API_URL=YOUR_API_URL npx -y flux-cloudflare-mcp

5. 將 YOUR_TOKEN 替換為你實際的 Flux API 令牌，將 YOUR_API_URL 替換為你的 API URL。
6. 保存設置，如有必要，重啟 Cursor。

Claude Desktop 集成

{
  "mcpServers": {
    "flux-cloudflare-mcp": {
      "command": "npx",
      "args": ["-y", "flux-cloudflare-mcp"],
      "env": {
        "FLUX_API_TOKEN": "YOUR_TOKEN",
        "FLUX_API_URL": "YOUR_API_URL"
      }
    }
  }
}

💻 本地開發

1. 克隆倉庫：

git clone https://github.com/Hzzy2O/flux-cloudflare-mcp.git
cd flux-cloudflare-mcp

2. 安裝依賴：

npm install

3. 構建項目：

npm run build

🔧 技術細節

• Model Context Protocol SDK：提供核心的 MCP 功能。
• Cloudflare Workers：用於圖像生成的無服務器 API。
• TypeScript：提供類型安全和現代 JavaScript 特性。
• Zod：用於運行時類型驗證。

⚙️ 配置

服務器需要以下環境變量：

• FLUX_API_TOKEN：用於與 Flux API 進行身份驗證的 API 令牌。
• FLUX_API_URL：你部署的 Flux API 的 URL（來自 snakeying/flux-api-worker 或 aigem/cf-flux-remix）。

🔍 故障排除

常見問題

身份驗證錯誤

• 確保你的 FLUX_API_TOKEN 已正確設置在環境變量中。
• 通過直接使用 Flux API 測試來驗證你的令牌是否有效。

API 連接問題

• 檢查你的 Flux API（Cloudflare Worker）是否正在運行且可訪問。
• 確保你的網絡允許連接到 Cloudflare Workers。

安全過濾器觸發

• 模型有一個內置的安全過濾器，可能會阻止某些提示。
• 嘗試修改你的提示以避免潛在的問題內容。

🤝 貢獻代碼

歡迎貢獻代碼！請隨時提交拉取請求。

1. 分叉倉庫。
2. 創建你的功能分支 (git checkout -b feature/amazing-feature)。
3. 提交你的更改 (git commit -m 'Add some amazing feature')。
4. 將更改推送到分支 (git push origin feature/amazing-feature)。
5. 打開一個拉取請求。

📄 許可證

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

🔗 資源

• 模型上下文協議文檔
• Cloudflare Workers 文檔
• Flux 模型文檔
• MCP TypeScript SDK
• snakeying/flux-api-worker - 簡單的 Flux API 實現
• aigem/cf-flux-remix - 帶有 Web UI 的功能豐富的 Flux API