Skip to main content
Glama
Sign In
deenesjakoruzh

GPT Image 1 MCP

by CLOUDWERX-DEV
npmGitHub
JavaScript
MIT License
323
1
  • Linux
  • Apple
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

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.

🚀 Quick Start

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

📋 Prerequisites

🔑 Environment Variables

💻 Example Usage with 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

🔌 Integration with MCP Clients

🛠️ Setting Up in an MCP Client

{ "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" } } } }
Example Configurations for Different Operating Systems
{ "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" } } } }

Note: For Windows paths, use double backslashes (\\) to escape the backslash character in JSON. For Linux/macOS, use forward slashes (/).

✨ Features

💡 Enhanced Capabilities

🔄 How It Works

📁 Output Directory Behavior

Installation & Usage

NPM Package

This package is available on npm: @cloudwerxlab/gpt-image-1-mcp

You can install it globally:

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

Or run it directly with npx as shown in the Quick Start section.

Tool: create_image

Generates a new image based on a text prompt.

Parameters
ParameterTypeRequiredDescription
promptstringYesThe text description of the image to generate (max 32,000 chars)
sizestringNoImage size: "1024x1024" (default), "1536x1024", or "1024x1536"
qualitystringNoImage quality: "high" (default), "medium", or "low"
nintegerNoNumber of images to generate (1-10, default: 1)
backgroundstringNoBackground style: "transparent", "opaque", or "auto" (default)
output_formatstringNoOutput format: "png" (default), "jpeg", or "webp"
output_compressionintegerNoCompression level (0-100, default: 0)
userstringNoUser identifier for OpenAI usage tracking
moderationstringNoModeration level: "low" or "auto" (default)
Example
<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>
Response

The tool returns:

  • A formatted text message with details about the generated image(s)
  • The image(s) as base64-encoded data
  • Metadata including token usage and file paths

Tool: create_image_edit

Edits an existing image based on a text prompt and optional mask.

Parameters
ParameterTypeRequiredDescription
imagestring, object, or arrayYesThe image(s) to edit (base64 string or file path object)
promptstringYesThe text description of the desired edit (max 32,000 chars)
maskstring or objectNoThe mask that defines areas to edit (base64 string or file path object)
sizestringNoImage size: "1024x1024" (default), "1536x1024", or "1024x1536"
qualitystringNoImage quality: "high" (default), "medium", or "low"
nintegerNoNumber of images to generate (1-10, default: 1)
backgroundstringNoBackground style: "transparent", "opaque", or "auto" (default)
userstringNoUser identifier for OpenAI usage tracking
Example with Base64 Encoded Image
<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>
Example with File Path
<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>
Response

The tool returns:

  • A formatted text message with details about the edited image(s)
  • The edited image(s) as base64-encoded data
  • Metadata including token usage and file paths

🔧 Troubleshooting

🚨 Common Issues

🔍 Error Handling and Reporting

The MCP server includes comprehensive error handling that provides detailed information when something goes wrong. When an error occurs:

  1. Error Format: All errors are returned with:
    • A clear error message describing what went wrong
    • The specific error code or type
    • Additional context about the error when available
  2. AI Assistant Behavior: When using this MCP server with AI assistants:
    • The AI will always report the full error message to help with troubleshooting
    • The AI will explain the likely cause of the error in plain language
    • The AI will suggest specific steps to resolve the issue

📄 License

🙏 Acknowledgments

You must be authenticated.

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

Tools

A Model Context Protocol server that enables generating and editing images using OpenAI's gpt-image-1 model, allowing AI assistants to create and modify images from text prompts.

  1. 📋 Prerequisites
    1. 🔑 Environment Variables
      1. 💻 Example Usage with NPX
        1. 🔌 Integration with MCP Clients
          1. 🛠️ Setting Up in an MCP Client
        2. ✨ Features
          1. 💡 Enhanced Capabilities
        3. 🔄 How It Works
          1. 📁 Output Directory Behavior
        4. Installation & Usage
          1. NPM Package
          2. Tool: create_image
          3. Tool: create_image_edit
        5. 🔧 Troubleshooting
          1. 🚨 Common Issues
          2. 🔍 Error Handling and Reporting
        6. 📄 License
          1. 🙏 Acknowledgments

            Related Resources

            Related MCP Servers

            • Ideogram MCP Server

              Sunwood-ai-labs
              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

            • OpenAI MCP

              jezweb
              -
              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

            • MCPollinations Multimodal MCP Server

              pinkpixel-dev
              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

            • OpenAI GPT Image MCP

              SureScaleAI
              -
              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

            New MCP Servers

            ID: msnns8io3m