MCP Flux Studio 使用说明

项目简介

MCP Flux Studio 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在将 Flux 强大的图像生成、处理和控制功能无缝集成到你的 AI 编码助手，例如 Cursor 和 Windsurf (Codeium)。通过此服务器，开发者可以直接在熟悉的 IDE 环境中利用 AI 进行图像创作和编辑，提升开发效率和创意空间。

主要功能点

图像生成: 通过文本提示词生成图像，支持多种 Flux 模型和自定义宽高比。
图像处理: 支持图生图转换、图像修复（inpainting）和分辨率提升等图像编辑功能。
高级控制: 提供基于边缘 (canny)、深度和姿势的图像生成控制，实现更精确的图像创作。
IDE 集成: 完美支持 Cursor 和 Windsurf/Codeium，工具可被 AI 助手自动发现和调用。

安装步骤

前提条件:
- 确保已安装 Node.js 18+ 和 Python 3.12+。
- 拥有 Flux API 密钥 (BFL_API_KEY)。
- 使用兼容的 IDE，如 Cursor (v0.45.7+) 或 Windsurf/Codeium Cascade (Wave 3+)。

安装方式:

通过 Smithery 自动安装 (Claude Desktop):

npx -y @smithery/cli install @jmanhype/mcp-flux-studio --client claude

手动安装:

git clone https://github.com/jmanhype/mcp-flux-studio.git
cd mcp-flux-studio
npm install
npm run build

基本配置: 创建 '.env' 文件或设置环境变量，配置 Flux API 密钥和 Flux 安装路径。

BFL_API_KEY=你的_flux_api_key
FLUX_PATH=/path/to/flux/installation

'FLUX_PATH' 指向 Flux 安装目录，例如 '/Users/speed/CascadeProjects/flux'。

服务器配置

为了让 MCP 客户端（如 Cursor 或 Codeium）连接到 MCP Flux Studio 服务器，您需要配置客户端的 MCP 设置。以下是配置示例，您需要根据您的实际安装路径进行调整。

Cursor 配置示例 (JSON):

{
  "serverName": "flux-server",
  "command": "node",
  "args": ["index.js"],
  "transport": "stdio",
  "environment": {
    "FLUX_PATH": "/path/to/flux/installation",  // Flux 安装路径，请替换为实际路径
    "BFL_API_KEY": "你的_flux_api_key"         // Flux API 密钥，请替换为实际密钥
  }
}

配置说明:

'serverName': 服务器名称，可以自定义。

'command': 启动服务器的命令，这里使用 'node'。

'args': 传递给 'node' 命令的参数，'index.js' 是构建后的服务器入口文件。

'transport': 传输协议，这里使用 'stdio' (标准输入输出)。

'environment': 环境变量，用于配置 'FLUX_PATH' 和 'BFL_API_KEY'。请务必替换 '/path/to/flux/installation' 为您的 Flux 安装路径，'你的_flux_api_key' 为您的 Flux API 密钥。

Codeium/Windsurf 配置示例 (JSON):

编辑 '~/.codeium/windsurf/mcp_config.json' 文件，添加如下配置:

{
  "servers": [
    {
      "name": "flux-server",
      "command": "node",
      "args": ["index.js"],
      "environment": {
        "FLUX_PATH": "/path/to/flux/installation",  // Flux 安装路径，请替换为实际路径
        "BFL_API_KEY": "你的_flux_api_key"         // Flux API 密钥，请替换为实际密钥
      }
    }
  ]
}

配置说明: 与 Cursor 配置类似，需要配置 'command', 'args' 和 'environment'，并确保 'FLUX_PATH' 和 'BFL_API_KEY' 设置正确。

基本使用方法

启动 MCP Flux Studio 服务器 (在项目根目录下执行 'node index.js' 或通过 Smithery 启动)。
在 Cursor 或 Codeium 中配置并启用 MCP Flux Studio 服务器。
在 IDE 中，AI 助手将自动发现并加载 MCP Flux Studio 提供的工具 (例如 'generate', 'img2img', 'inpaint', 'control')。
通过自然语言指令或 IDE 提供的界面调用这些工具，例如在 Cursor 中，您可以输入类似 '#generate a cat' 的指令来生成猫的图像。
根据工具的输入参数（例如 'prompt', 'image', 'model' 等）提供相应的参数值。
AI 助手会请求 MCP Flux Studio 服务器执行工具，并在 IDE 中返回图像生成结果。

请参考 API 文档和示例用法了解更多工具细节和使用方法。

关键词