使用说明

项目简介

image-gen MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它扩展了大型语言模型 (LLM) 的能力,使其能够调用 Stable Diffusion WebUI 生成图像。该服务器提供了一个名为 'generate_image' 的工具,允许 LLM 客户端通过发送文本描述来生成图像。

主要功能点

  • 文本到图像生成: 提供 'generate_image' 工具,根据文本提示生成图像。
  • 参数可配置: 支持丰富的图像生成参数,如 prompt, negative_prompt, 采样步数, 图像尺寸, CFG scale, 采样器, 调度器, 种子, 批量大小等。
  • Stable Diffusion WebUI 集成: 无缝对接 Stable Diffusion WebUI API (ForgeUI/AUTOMATIC-1111),利用其强大的图像生成能力。
  • 灵活的输出: 允许自定义图像输出路径。
  • 错误处理: 提供详细的错误信息,方便问题排查。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/Ichigo3766/image-gen-mcp.git
    cd image-gen-mcp
  2. 安装依赖: 确保已安装 Node.js 和 npm。运行以下命令安装项目依赖:

    npm install
  3. 构建服务器: 运行以下命令构建服务器代码:

    npm run build

服务器配置

MCP 客户端需要配置以下 JSON 格式信息才能连接到 image-gen MCP 服务器。请根据您的实际环境修改以下参数:

{
  "mcpServers": {
    "image-gen": {
      "command": "node",
      "args": [
        "/path/to/image-gen-mcp/build/index.js"  // 修改为 image-gen-mcp 项目 build 目录下 index.js 文件的绝对路径
      ],
      "env": {
        "SD_WEBUI_URL": "http://your-sd-webui-url:7860",  // 您的 Stable Diffusion WebUI API 地址,例如 http://127.0.0.1:7860
        "SD_AUTH_USER": "your-username",  // [可选] 如果 Stable Diffusion WebUI 启用了身份验证,请填写用户名
        "SD_AUTH_PASS": "your-password",  // [可选] 如果 Stable Diffusion WebUI 启用了身份验证,请填写密码
        "SD_OUTPUT_DIR": "/path/to/output/directory"  // [可选] 生成图像的默认输出目录,例如 /path/to/output/directory,默认为服务器目录下的 ./output 目录
      }
    }
  }
}

参数说明:

  • 'command': 启动 MCP 服务器的命令,这里使用 'node' 运行 JavaScript 代码。
  • 'args': 传递给 'node' 命令的参数,指向构建后的服务器入口文件 'index.js' 的路径。请务必替换 '/path/to/image-gen-mcp' 为您本地仓库的实际路径。
  • 'env': 环境变量配置,用于配置 Stable Diffusion WebUI API 的连接信息和输出目录。
    • 'SD_WEBUI_URL': [必填] Stable Diffusion WebUI 的 API 地址。确保 WebUI 启动时已启用 '--api' 参数。
    • 'SD_AUTH_USER': [可选] Stable Diffusion WebUI 的用户名,如果 WebUI 需要身份验证则填写。
    • 'SD_AUTH_PASS': [可选] Stable Diffusion WebUI 的密码,如果 WebUI 需要身份验证则填写。
    • 'SD_OUTPUT_DIR': [可选] 生成图像的默认保存目录。

基本使用方法

  1. 确保 Stable Diffusion WebUI 实例已启动,并且 API 功能已启用 ('--api' 启动参数)。
  2. 配置 MCP 客户端,添加上述服务器配置信息。
  3. 通过 MCP 客户端向 image-gen MCP 服务器发送请求,调用 'generate_image' 工具,并提供相应的参数,例如 'prompt' (文本描述) 等。
  4. 服务器将调用 Stable Diffusion WebUI API 生成图像,并将结果返回给 MCP 客户端。生成的图像默认保存在服务器配置中 'SD_OUTPUT_DIR' 指定的目录下。

注意: 请确保 MCP 服务器可以访问到配置的 Stable Diffusion WebUI API 地址。如果遇到连接问题,请检查网络配置和 WebUI 的运行状态。

信息

分类

AI与计算