使用说明

项目简介

mcp-flux-schnell 是一个 MCP (Model Context Protocol) 服务器，它利用 Cloudflare 的 Flux Schnell 模型 API，将文本描述转换为图像。此服务器旨在与支持 MCP 协议的客户端（如 Cursor 编辑器或 Claude 桌面应用）集成，为用户提供便捷的图像生成能力。

主要功能点

文本生成图像工具： 提供 'generate_image' 工具，允许用户通过文本提示词生成图像。
Flux Schnell 模型集成： 使用 Cloudflare Flux Schnell API 作为图像生成后端。
MCP 协议支持： 遵循 MCP 协议标准，与 MCP 客户端进行通信和功能交互。
工具能力声明： 向客户端声明服务器提供的 'generate_image' 工具及其参数。
环境变量配置： 通过环境变量灵活配置 Flux Schnell API 的 URL 和 Token，以及工作目录。

安装步骤

克隆仓库:

git clone https://github.com/bytefer/mcp-flux-schnell.git
cd mcp-flux-schnell

安装依赖:

npm install  # 或 pnpm install

构建项目:

npm run build  # 或 pnpm build

服务器配置

要将此 MCP 服务器与 MCP 客户端（例如 Cursor 编辑器）连接，您需要在客户端中配置 MCP 服务器信息。以下是 Cursor 编辑器的配置示例，您需要将以下 JSON 配置添加到 Cursor 的 MCP 配置文件 ('.cursor/mcp.json' 或 '~/.cursor/mcp.json') 中。

{
  "mcpServers": {
    "mcp-flux-schnell": {
      "command": "node",
      "args": ["/path/to/mcp-flux-schnell/build/index.js"],
      "env": {
        "FLUX_API_URL": "您的 Flux API URL",  //  替换为您的 Flux Schnell API 端点 URL
        "FLUX_API_TOKEN": "您的 Flux API Token", // 替换为您的 Flux Schnell API 认证 Token
        "WORKING_DIR": "图像保存目录 (可选，默认为当前工作目录)" // 可选配置，指定生成的图像保存的目录
      }
    }
  }
}

配置参数说明:

'server name': 'mcp-flux-schnell' - 服务器名称，用于在客户端中标识和引用。
'command': 'node' - 启动服务器的命令，这里使用 Node.js 运行 JavaScript 代码。
'args': '["/path/to/mcp-flux-schnell/build/index.js"]' - 命令参数，指向构建后的服务器入口文件 'index.js' 的路径。请将 '/path/to/mcp-flux-schnell' 替换为您的 'mcp-flux-schnell' 仓库的实际路径。
'env': 环境变量配置，包含以下键值对：
- 'FLUX_API_URL': 必需。Flux Schnell API 的 URL，您需要从 Cloudflare 获取。
- 'FLUX_API_TOKEN': 必需。Flux Schnell API 的认证 Token，用于访问 API。
- 'WORKING_DIR': 可选。指定生成图像的保存目录。如果未设置，默认保存到服务器启动的当前工作目录。

基本使用方法

配置完成后，在支持 MCP 协议的客户端中，您应该能够找到并使用 'generate_image' 工具。

在客户端中触发工具调用： 具体操作方式取决于 MCP 客户端的界面。通常，您可以在客户端的工具菜单或命令面板中找到已注册的 MCP 服务器和工具。
输入文本提示词： 选择 'generate_image' 工具后，客户端会提示您输入文本提示词。请根据工具的描述，输入 1-2048 个字符的文本，描述您想要生成的图像内容。
等待图像生成： 客户端会将请求发送到 MCP 服务器，服务器调用 Flux Schnell API 生成图像。
查看生成结果： 生成成功后，服务器会将图像保存到配置的 'WORKING_DIR' 目录，并返回图像的文件路径信息给客户端。您可以在客户端或指定的目录下查看生成的图像。

注意:

您需要拥有 Cloudflare Flux Schnell API 的访问权限和 API 密钥才能使用此服务器。
请确保正确配置 'FLUX_API_URL' 和 'FLUX_API_TOKEN' 环境变量。
首次运行前请先构建项目 ('npm run build')。

关键词