<p align="center">

</p>

<h1 align="center">@cloudwerxlab/gpt-image-1-mcp</h1>

<p align="center">
<a href="https://www.npmjs.com/package/@cloudwerxlab/gpt-image-1-mcp"></a>
<a href="https://www.npmjs.com/package/@cloudwerxlab/gpt-image-1-mcp"></a>
<a href="https://github.com/CLOUDWERX-DEV/gpt-image-1-mcp/blob/main/LICENSE"></a>
<a href="https://nodejs.org/"></a>
<a href="https://cloudwerx.dev"></a>
</p>

<p align="center">
A Model Context Protocol (MCP) server for generating and editing images using the OpenAI <code>gpt-image-1</code> model.
</p>

<p align="center">


</p>

🚀 Quick Start

<div align="center">
<a href="https://www.npmjs.com/package/@cloudwerxlab/gpt-image-1-mcp"></a>
</div>

<p align="center">Run this MCP server directly using NPX without installing it. <a href="https://www.npmjs.com/package/@cloudwerxlab/gpt-image-1-mcp">View on npm</a>.</p>

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

<p align="center">The <code>-y</code> flag automatically answers "yes" to any prompts that might appear during the installation process.</p>

📋 Prerequisites

<table>
<tr>
<td width="50%" align="center">

<p>Node.js (v14 or higher)</p>
</td>
<td width="50%" align="center">

<p>OpenAI API key with access to gpt-image-1</p>
</td>
</tr>
</table>

🔑 Environment Variables

<table>
<tr>
<th>Variable</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td><code>OPENAI_API_KEY</code></td>
<td>✅ Yes</td>
<td>Your OpenAI API key with access to the gpt-image-1 model</td>
</tr>
<tr>
<td><code>GPT_IMAGE_OUTPUT_DIR</code></td>
<td>❌ No</td>
<td>Custom directory for saving generated images (defaults to user's Pictures folder under <code>gpt-image-1</code> subfolder)</td>
</tr>
</table>

💻 Example Usage with NPX

<table>
<tr>
<th>Operating System</th>
<th>Command Line Example</th>
</tr>
<tr>
<td><strong>Linux/macOS</strong></td>
<td>

# 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

</tr> <tr> <td><strong>Windows (PowerShell)</strong></td> <td>

# 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

</tr> <tr> <td><strong>Windows (Command Prompt)</strong></td> <td>

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

</tr>
</table>

🔌 Integration with MCP Clients

<div align="center">





</div>

🛠️ Setting Up in an MCP Client

<table>
<tr>
<td>
<h4>Step 1: Locate Settings File</h4>
<ul>
<li>For <strong>Roo</strong>: <code>c:\Users\&lt;username&gt;\AppData\Roaming\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\mcp_settings.json</code></li>
<li>For <strong>VS Code MCP Extension</strong>: Check your extension documentation for the settings file location</li>
<li>For <strong>Cursor</strong>: <code>~/.config/cursor/mcp_settings.json</code> (Linux/macOS) or <code>%APPDATA%\Cursor\mcp_settings.json</code> (Windows)</li>
<li>For <strong>Augment</strong>: <code>~/.config/augment/mcp_settings.json</code> (Linux/macOS) or <code>%APPDATA%\Augment\mcp_settings.json</code> (Windows)</li>
<li>For <strong>Windsurf</strong>: <code>~/.config/windsurf/mcp_settings.json</code> (Linux/macOS) or <code>%APPDATA%\Windsurf\mcp_settings.json</code> (Windows)</li>
</ul>
</td>
</tr>
<tr>
<td>
<h4>Step 2: Add Configuration</h4>
<p>Add the following configuration to the <code>mcpServers</code> object:</p>
</td>
</tr>
</table>

{
  "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

<table>
<tr>
<th>Operating System</th>
<th>Example Configuration</th>
</tr>
<tr>
<td><strong>Windows</strong></td>
<td>

{
  "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"
      }
    }
  }
}

</tr> <tr> <td><strong>Linux/macOS</strong></td> <td>

{
  "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"
      }
    }
  }
}

</tr> </table>

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

✨ Features

<div align="center">
<table>
<tr>
<td align="center">
<h3>🎨 Core Tools</h3>
<ul>
<li><code>create_image</code>: Generate new images from text prompts</li>
<li><code>create_image_edit</code>: Edit existing images with text prompts and masks</li>
</ul>
</td>
<td align="center">
<h3>🚀 Key Benefits</h3>
<ul>
<li>Simple integration with MCP clients</li>
<li>Full access to OpenAI's gpt-image-1 capabilities</li>
<li>Streamlined workflow for AI image generation</li>
</ul>
</td>
</tr>
</table>
</div>

💡 Enhanced Capabilities

…