GPT Image 1 MCP

MIT License
323
1
  • Linux
  • Apple

Integrations

  • Uses curl commands for proper MIME handling when working with image files, especially for the image editing functionality.

  • Runs as a Node.js application, with the MCP server requiring Node.js v14+ to function properly.

  • Available as an npm package that can be installed globally or run directly with npx, making it easy to integrate with various MCP clients.

🚀 快速入门

npx -y @cloudwerxlab/gpt-image-1-mcp

📋 先决条件

🔑 环境变量

💻 NPX 用法示例

# Set your OpenAI API key export OPENAI_API_KEY=sk-your-openai-api-key # Optional: Set custom output directory export GPT_IMAGE_OUTPUT_DIR=/home/username/Pictures/ai-generated-images # Run the server with NPX npx -y @cloudwerxlab/gpt-image-1-mcp
# Set your OpenAI API key $env:OPENAI_API_KEY = "sk-your-openai-api-key" # Optional: Set custom output directory $env:GPT_IMAGE_OUTPUT_DIR = "C:\Users\username\Pictures\ai-generated-images" # Run the server with NPX npx -y @cloudwerxlab/gpt-image-1-mcp
:: Set your OpenAI API key set OPENAI_API_KEY=sk-your-openai-api-key :: Optional: Set custom output directory set GPT_IMAGE_OUTPUT_DIR=C:\Users\username\Pictures\ai-generated-images :: Run the server with NPX npx -y @cloudwerxlab/gpt-image-1-mcp

🔌 与 MCP 客户端集成

🛠️ 在 MCP 客户端中设置

{ "mcpServers": { "gpt-image-1": { "command": "npx", "args": [ "-y", "@cloudwerxlab/gpt-image-1-mcp" ], "env": { "OPENAI_API_KEY": "PASTE YOUR OPEN-AI KEY HERE", "GPT_IMAGE_OUTPUT_DIR": "OPTIONAL: PATH TO SAVE GENERATED IMAGES" } } } }
不同操作系统的示例配置
{ "mcpServers": { "gpt-image-1": { "command": "npx", "args": ["-y", "@cloudwerxlab/gpt-image-1-mcp"], "env": { "OPENAI_API_KEY": "sk-your-openai-api-key", "GPT_IMAGE_OUTPUT_DIR": "C:\\Users\\username\\Pictures\\ai-generated-images" } } } }
{ "mcpServers": { "gpt-image-1": { "command": "npx", "args": ["-y", "@cloudwerxlab/gpt-image-1-mcp"], "env": { "OPENAI_API_KEY": "sk-your-openai-api-key", "GPT_IMAGE_OUTPUT_DIR": "/home/username/Pictures/ai-generated-images" } } } }

注意:对于 Windows 路径,请使用双反斜杠 ( \\ ) 来转义 JSON 中的反斜杠字符。对于 Linux/macOS,请使用正斜杠 ( / )。

✨ 特点

💡 增强功能

🔄 工作原理

📁 输出目录行为

安装和使用

NPM 包

此软件包可在 npm 上获取: @cloudwerxlab/gpt-image-1-mcp

您可以全局安装它:

npm install -g @cloudwerxlab/gpt-image-1-mcp

或者直接使用 npx 运行它,如快速入门部分所示。

工具: create_image

根据文本提示生成新图像。

参数
范围类型必需的描述
prompt细绳是的要生成的图像的文本描述(最多 32,000 个字符)
size细绳图像尺寸:“1024x1024”(默认)、“1536x1024”或“1024x1536”
quality细绳图像质量:“高”(默认)、“中”或“低”
n整数生成的图像数量(1-10,默认值:1)
background细绳背景样式:“透明”、“不透明”或“自动”(默认)
output_format细绳输出格式:“png”(默认)、“jpeg”或“webp”
output_compression整数压缩级别(0-100,默认值:0)
user细绳OpenAI 使用情况跟踪的用户标识符
moderation细绳审核级别:“低”或“自动”(默认)
例子
<use_mcp_tool> <server_name>gpt-image-1</server_name> <tool_name>create_image</tool_name> <arguments> { "prompt": "A futuristic city skyline at sunset, digital art", "size": "1024x1024", "quality": "high", "n": 1, "background": "auto" } </arguments> </use_mcp_tool>
回复

该工具返回:

  • 包含所生成图像详细信息的格式化文本消息
  • 以 base64 编码的数据格式显示图像
  • 元数据包括令牌使用情况和文件路径

工具: create_image_edit

根据文本提示和可选掩码编辑现有图像。

参数
范围类型必需的描述
image字符串、对象或数组是的要编辑的图像(base64字符串或文件路径对象)
prompt细绳是的所需编辑的文本描述(最多 32,000 个字符)
mask字符串或对象定义要编辑的区域的掩码(base64字符串或文件路径对象)
size细绳图像尺寸:“1024x1024”(默认)、“1536x1024”或“1024x1536”
quality细绳图像质量:“高”(默认)、“中”或“低”
n整数生成的图像数量(1-10,默认值:1)
background细绳背景样式:“透明”、“不透明”或“自动”(默认)
user细绳OpenAI 使用情况跟踪的用户标识符
Base64 编码图像示例
<use_mcp_tool> <server_name>gpt-image-1</server_name> <tool_name>create_image_edit</tool_name> <arguments> { "image": "BASE64_ENCODED_IMAGE_STRING", "prompt": "Add a small robot in the corner", "mask": "BASE64_ENCODED_MASK_STRING", "quality": "high" } </arguments> </use_mcp_tool>
文件路径示例
<use_mcp_tool> <server_name>gpt-image-1</server_name> <tool_name>create_image_edit</tool_name> <arguments> { "image": { "filePath": "C:/path/to/your/image.png" }, "prompt": "Add a small robot in the corner", "mask": { "filePath": "C:/path/to/your/mask.png" }, "quality": "high" } </arguments> </use_mcp_tool>
回复

该工具返回:

  • 包含已编辑图像详细信息的格式化文本消息
  • 编辑后的图像作为 base64 编码数据
  • 元数据包括令牌使用情况和文件路径

🔧 故障排除

🚨常见问题

🔍 错误处理和报告

MCP 服务器包含全面的错误处理功能,可在出现问题时提供详细信息。发生错误时:

  1. 错误格式:所有错误均返回:
    • 清晰的错误信息,描述出了什么问题
    • 具体的错误代码或类型
    • 如果有关于错误的附加上下文
  2. AI 助手行为:当此 MCP 服务器与 AI 助手一起使用时:
    • 人工智能将始终报告完整的错误消息以帮助排除故障
    • 人工智能将用通俗易懂的语言解释错误的可能原因
    • 人工智能将建议解决问题的具体步骤

📄 许可证

🙏 致谢

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

模型上下文协议服务器,可使用 OpenAI 的 gpt-image-1 模型生成和编辑图像,从而允许 AI 助手根据文本提示创建和修改图像。

  1. 📋 先决条件
    1. 🔑 环境变量
      1. 💻 NPX 用法示例
        1. 🔌 与 MCP 客户端集成
          1. 🛠️ 在 MCP 客户端中设置
        2. ✨ 特点
          1. 💡 增强功能
        3. 🔄 工作原理
          1. 📁 输出目录行为
        4. 安装和使用
          1. NPM 包
          2. 工具: create_image
          3. 工具: create_image_edit
        5. 🔧 故障排除
          1. 🚨常见问题
          2. 🔍 错误处理和报告
        6. 📄 许可证
          1. 🙏 致谢

            Related MCP Servers

            • A
              security
              F
              license
              A
              quality
              A Model Context Protocol server that provides image generation capabilities using the Ideogram API, allowing users to create images from text prompts with customizable parameters.
              Last updated -
              1
              1
              3
              JavaScript
            • -
              security
              -
              license
              -
              quality
              A Model Context Protocol server enabling AI assistants to generate images through OpenAI's DALL-E API with full support for all available options and fine-grained control.
              Last updated -
              JavaScript
              MIT License
            • A
              security
              A
              license
              A
              quality
              A Model Context Protocol server that enables AI assistants to generate images, text, and audio through the Pollinations APIs without requiring authentication.
              Last updated -
              7
              325
              4
              JavaScript
              MIT License
              • Linux
              • Apple
            • -
              security
              A
              license
              -
              quality
              An MCP tool server that enables generating and editing images through OpenAI's image models, supporting text-to-image generation and advanced image editing (inpainting, outpainting) across various MCP-compatible clients.
              Last updated -
              11
              TypeScript
              MIT License

            View all related MCP servers

            ID: msnns8io3m