JinDaGe - flux-cloudfare-mcp MCP Details

article

README

🚀 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 模型：

分叉 flux-api-worker 仓库。
将其部署到 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"）。
部署完成后，你的 API 将在 https://your-worker-name.your-subdomain.workers.dev 可用。
使用此 URL 作为 FLUX_API_URL，并将你选择的 API 密钥作为 FLUX_API_TOKEN。

选项 2：使用 aigem/cf-flux-remix 部署

如果你需要一个带有 Web UI 的功能更丰富的实现，可以使用 aigem/cf-flux-remix：

按照 cf-flux-remix 仓库中的安装说明进行操作。
部署完成后，你的 API 将在你部署的 URL 可用。
使用此 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

在你的项目目录中创建或编辑 .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"]
    }
  }
}

将 YOUR_TOKEN 替换为你实际的 Flux API 令牌，将 YOUR_API_URL 替换为你的 API URL。
重启 Cursor 以应用更改。

方法 2：使用 Cursor MCP 设置

打开 Cursor 并进入设置。
导航到“MCP”或“Model Context Protocol”部分。
点击“添加服务器”或类似选项。
在相应字段中输入以下命令：

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

将 YOUR_TOKEN 替换为你实际的 Flux API 令牌，将 YOUR_API_URL 替换为你的 API URL。
保存设置，如有必要，重启 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"
      }
    }
  }
}

💻 本地开发

克隆仓库：

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

安装依赖：

npm install

构建项目：

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。

安全过滤器触发

模型有一个内置的安全过滤器，可能会阻止某些提示。
尝试修改你的提示以避免潜在的问题内容。

🤝 贡献代码

欢迎贡献代码！请随时提交拉取请求。

分叉仓库。
创建你的功能分支 (git checkout -b feature/amazing-feature)。
提交你的更改 (git commit -m 'Add some amazing feature')。
将更改推送到分支 (git push origin feature/amazing-feature)。
打开一个拉取请求。

📄 许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。

🔗 资源

模型上下文协议文档
Cloudflare Workers 文档
Flux 模型文档
MCP TypeScript SDK
snakeying/flux-api-worker - 简单的 Flux API 实现
aigem/cf-flux-remix - 带有 Web UI 的功能丰富的 Flux API

flux-cloudfare-mcp