openai-gpt-image-mcp

openai-gpt-image-mcp

MCP-compatible server for image generation and editing via OpenAI APIs.

70
Stars
21
Forks
70
Watchers
0
Issues
Provides a Model Context Protocol (MCP) tool server that interfaces with OpenAI's GPT-4o/gpt-image-1 APIs to generate and edit images from text prompts. Supports advanced image editing operations including inpainting, outpainting, and compositing with customizable options. Integrates with MCP-compatible clients such as Claude Desktop, VSCode, Cursor, and Windsurf. Offers both base64 and file output for generated images, with automatic file handling for large images.

Key Features

Text-to-image generation using OpenAI's GPT models
Image editing including inpainting, outpainting, and compositing
Support for multiple input and output formats (file path, base64)
Configurable server for integration with MCP-compatible clients
Advanced prompt and parameter control (size, quality, background, etc.)
Automatic output switching for large files (base64 to file path)
Customizable environment and Azure deployment support
Batch image generation (generate up to 10 images at once)
Mask support in edit operations
Environment variable and env-file configuration

Use Cases

Generating custom images from textual prompts for creative projects
Editing images to add, remove, or modify content via prompts
Integrating AI-driven image operations into developer workflows within editors like VSCode or Cursor
Automating batch creation of marketing or social media images
Building tools for visual storytelling or design prototyping
Enhancing documentation or presentations with AI-generated visuals
Providing image generation capabilities in chatbots or digital assistants
Researching advanced AI-powered image manipulation techniques
Automating image content augmentation in enterprise applications
Supporting designers and artists with AI-assisted creativity tools

README

openai-gpt-image-mcp


A Model Context Protocol (MCP) tool server for OpenAI's GPT-4o/gpt-image-1 image generation and editing APIs.

  • Generate images from text prompts using OpenAI's latest models.
  • Edit images (inpainting, outpainting, compositing) with advanced prompt control.
  • Supports: Claude Desktop, Cursor, VSCode, Windsurf, and any MCP-compatible client.

✨ Features

  • create-image: Generate images from a prompt, with advanced options (size, quality, background, etc).
  • edit-image: Edit or extend images using a prompt and optional mask, supporting both file paths and base64 input.
  • File output: Save generated images directly to disk, or receive as base64.

🚀 Installation

sh
git clone https://github.com/SureScaleAI/openai-gpt-image-mcp.git
cd openai-gpt-image-mcp
yarn install
yarn build

🔑 Configuration

Add to Claude Desktop or VSCode (including Cursor/Windsurf) config:

json
{
  "mcpServers": {
    "openai-gpt-image-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/dist/index.js"],
      "env": { "OPENAI_API_KEY": "sk-..." }
    }
  }
}

Also supports Azure deployments:

json
{
  "mcpServers": {
    "openai-gpt-image-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/dist/index.js"],
      "env": { 
        "AZURE_OPENAI_API_KEY": "sk-...",
        "AZURE_OPENAI_ENDPOINT": "my.endpoint.com",
        "OPENAI_API_VERSION": "2024-12-01-preview"
      }
    }
  }
}

Also supports supplying an environment files:

json
{
  "mcpServers": {
    "openai-gpt-image-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/dist/index.js", "--env-file", "./deployment/.env"]
    }
  }
}

⚡ Advanced

  • For create-image, set n to generate up to 10 images at once.
  • For edit-image, provide a mask image (file path or base64) to control where edits are applied.
  • Provide an environment file with --env-file path/to/file/.env
  • See src/index.ts for all options.

🧑‍💻 Development

  • TypeScript source: src/index.ts
  • Build: yarn build
  • Run: node dist/index.js

📝 License

MIT


🩺 Troubleshooting

  • Make sure your OPENAI_API_KEY is valid and has image API access.
  • You must have a verified OpenAI organization. After verifying, it can take 15–20 minutes for image API access to activate.
  • File paths must be absolute.
    • Unix/macOS/Linux: Starting with / (e.g., /path/to/image.png)
    • Windows: Drive letter followed by : (e.g., C:/path/to/image.png or C:\path\to\image.png)
  • For file output, ensure the directory is writable.
  • If you see errors about file types, check your image file extensions and formats.

⚠️ Limitations & Large File Handling

  • 1MB Payload Limit: MCP clients (including Claude Desktop) have a hard 1MB limit for tool responses. Large images (especially high-res or multiple images) can easily exceed this limit if returned as base64.
  • Auto-Switch to File Output: If the total image size exceeds 1MB, the tool will automatically save images to disk and return the file path(s) instead of base64. This ensures compatibility and prevents errors like result exceeds maximum length of 1048576.
  • Default File Location: If you do not specify a file_output path, images will be saved to /tmp (or the directory set by the MCP_HF_WORK_DIR environment variable) with a unique filename.
  • Environment Variable:
    • MCP_HF_WORK_DIR: Set this to control where large images and file outputs are saved. Example: export MCP_HF_WORK_DIR=/your/desired/dir
  • Best Practice: For large or production images, always use file output and ensure your client is configured to handle file paths.

📚 References


🙏 Credits

Star History

Star History Chart

Repository Owner

SureScaleAI
SureScaleAI

Organization

Repository Details

Language TypeScript
Default Branch master
Size 8,884 KB
Contributors 2
License MIT License
MCP Verified Sep 1, 2025

Programming Languages

TypeScript
100%

Tags

Join Our Newsletter

Stay updated with the latest AI tools, news, and offers by subscribing to our weekly newsletter.

We respect your privacy. Unsubscribe at any time.

Related MCPs

Discover similar Model Context Protocol servers

  • manim-mcp-server

    manim-mcp-server

    MCP server for generating Manim animations on demand.

    Manim MCP Server allows users to execute Manim Python scripts via a standardized protocol, generating animation videos that are returned as output. It integrates with systems like Claude to dynamically render animation content from user scripts and supports configurable deployment using environment variables. The server handles management of output files and cleanup of temporary resources, designed with portability and ease of integration in mind.

    • 454
    • MCP
    • abhiemj/manim-mcp-server
  • mcp-open-library

    mcp-open-library

    Model Context Protocol server for accessing Open Library book and author data.

    Provides an implementation of a Model Context Protocol (MCP) server to enable AI assistants and clients to search and retrieve book and author information from the Open Library API. Supports searching by title, author name, and various identifiers, as well as fetching author photos and book covers. Returns structured, machine-readable data suitable for AI model context integration. Offers installation via Smithery, manual setup, and Docker deployment.

    • 34
    • MCP
    • 8enSmith/mcp-open-library
  • OpenMCP

    OpenMCP

    A standard and registry for converting web APIs into MCP servers.

    OpenMCP defines a standard for converting various web APIs into servers compatible with the Model Context Protocol (MCP), enabling efficient, token-aware communication with client LLMs. It also provides an open-source registry of compliant servers, allowing clients to access a wide array of external services. The platform supports integration with local and remote hosting environments and offers tools for configuring supported clients, such as Claude desktop and Cursor. Comprehensive guidance is offered for adapting different API formats including REST, gRPC, GraphQL, and more into MCP endpoints.

    • 252
    • MCP
    • wegotdocs/open-mcp
  • imagen3-mcp

    imagen3-mcp

    Google Imagen 3.0 image generation service with MCP protocol integration.

    Imagen3-MCP is an image generation tool leveraging Google's Imagen 3.0 model and exposes its functionality via the Model Control Protocol (MCP). It requires a valid Google Gemini API key and can be easily deployed as a standalone executable. The tool supports flexible configuration with various environment variables and integrates with platforms like Cherry Studio and Cursor for seamless image generation tasks. Example prompts and outputs are provided to showcase its photorealistic image creation capabilities.

    • 43
    • MCP
    • hamflx/imagen3-mcp
  • mcp-server-js

    mcp-server-js

    Enable secure, AI-driven process automation and code execution on YepCode via Model Context Protocol.

    YepCode MCP Server acts as a Model Context Protocol (MCP) server that facilitates seamless communication between AI platforms and YepCode’s workflow automation infrastructure. It allows AI assistants and clients to execute code, manage environment variables, and interact with storage through standardized tools. The server can expose YepCode processes directly as MCP tools and supports both hosted and local installations via NPX or Docker. Enterprise-grade security and real-time interaction make it suitable for integrating advanced automation into AI-powered environments.

    • 31
    • MCP
    • yepcode/mcp-server-js
  • 1mcp-app/agent

    1mcp-app/agent

    A unified server that aggregates and manages multiple Model Context Protocol servers.

    1MCP Agent provides a single, unified interface that aggregates multiple Model Context Protocol (MCP) servers, enabling seamless integration and management of external tools for AI assistants. It acts as a proxy, managing server configuration, authentication, health monitoring, and dynamic server control with features like asynchronous loading, tag-based filtering, and advanced security options. Compatible with popular AI development environments, it simplifies setup by reducing redundant server instances and resource usage. Users can configure, monitor, and scale model tool integrations across various AI clients through easy CLI commands or Docker deployment.

    • 96
    • MCP
    • 1mcp-app/agent
  • Didn't find tool you were looking for?

    Be as detailed as possible for better results