![\"GPT](\"logo.png\")
\n\n \n
\n ![\"npm](\"https://img.shields.io/npm/v/@cloudwerxlab/gpt-image-1-mcp.svg\")
\n ![\"npm](\"https://img.shields.io/npm/dm/@cloudwerxlab/gpt-image-1-mcp.svg\")
\n ![\"license\"](\"https://img.shields.io/github/license/CLOUDWERX-DEV/gpt-image-1-mcp.svg\")
\n ![\"node](\"https://img.shields.io/node/v/@cloudwerxlab/gpt-image-1-mcp.svg\")
\n ![\"Website\"](\"https://img.shields.io/badge/website-cloudwerx.dev-blue\"){kind=icon}
\n A Model Context Protocol (MCP) server for generating and editing images using the OpenAI gpt-image-1 model.\n
\n ![\"OpenAI](\"https://img.shields.io/badge/OpenAI-GPT--Image--1-6E46AE\"){kind=icon}
![\"MCP](\"https://img.shields.io/badge/MCP-Compatible-00A3E0\"){kind=icon}
![\"NPX](\"https://img.shields.io/badge/NPX-Ready-red.svg\"){kind=icon}
\nRun this MCP server directly using NPX without installing it. View on npm.
\n\n```bash\nnpx -y @cloudwerxlab/gpt-image-1-mcp\n```\n\nThe -y flag automatically answers \"yes\" to any prompts that might appear during the installation process.
\n ![\"Node.js](\"https://img.shields.io/badge/Node.js-v14+-339933?logo=node.js&logoColor=white\"){kind=icon} \n Node.js (v14 or higher) \n | \n \n ![\"OpenAI](\"https://img.shields.io/badge/OpenAI-API_Key-412991?logo=openai&logoColor=white\"){kind=icon} \n OpenAI API key with access to gpt-image-1 \n | \n
| Variable | \nRequired | \nDescription | \n
|---|---|---|
OPENAI_API_KEY | \n ✅ Yes | \nYour OpenAI API key with access to the gpt-image-1 model | \n
GPT_IMAGE_OUTPUT_DIR | \n ❌ No | \nCustom directory for saving generated images (defaults to user's Pictures folder under gpt-image-1 subfolder) | \n
| Operating System | \nCommand Line Example | \n
|---|---|
| Linux/macOS | \n\n\n```bash\n# Set your OpenAI API key\nexport OPENAI_API_KEY=sk-your-openai-api-key\n\n# Optional: Set custom output directory\nexport GPT_IMAGE_OUTPUT_DIR=/home/username/Pictures/ai-generated-images\n\n# Run the server with NPX\nnpx -y @cloudwerxlab/gpt-image-1-mcp\n```\n |
| Windows (PowerShell) | \n\n\n```powershell\n# Set your OpenAI API key\n$env:OPENAI_API_KEY = \"sk-your-openai-api-key\"\n\n# Optional: Set custom output directory\n$env:GPT_IMAGE_OUTPUT_DIR = \"C:\\Users\\username\\Pictures\\ai-generated-images\"\n\n# Run the server with NPX\nnpx -y @cloudwerxlab/gpt-image-1-mcp\n```\n |
| Windows (Command Prompt) | \n\n\n```cmd\n:: Set your OpenAI API key\nset OPENAI_API_KEY=sk-your-openai-api-key\n\n:: Optional: Set custom output directory\nset GPT_IMAGE_OUTPUT_DIR=C:\\Users\\username\\Pictures\\ai-generated-images\n\n:: Run the server with NPX\nnpx -y @cloudwerxlab/gpt-image-1-mcp\n```\n |
![\"VS](\"https://img.shields.io/badge/VS_Code-MCP_Extension-007ACC?logo=visual-studio-code&logoColor=white\"){kind=icon}
\n ![\"Roo](\"https://img.shields.io/badge/Roo-Compatible-FF6B6B\"){kind=icon}
\n ![\"Cursor](\"https://img.shields.io/badge/Cursor-Compatible-4C2889\"){kind=icon}
\n ![\"Augment](\"https://img.shields.io/badge/Augment-Compatible-6464FF\"){kind=icon}
\n ![\"Windsurf](\"https://img.shields.io/badge/Windsurf-Compatible-00B4D8\"){kind=icon}
\n\n Step 1: Locate Settings File\n
| \n
\n Step 2: Add Configuration\nAdd the following configuration to the | \n
| Operating System | \nExample Configuration | \n
|---|---|
| Windows | \n\n\n```json\n{\n \"mcpServers\": {\n \"gpt-image-1\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"@cloudwerxlab/gpt-image-1-mcp\"],\n \"env\": {\n \"OPENAI_API_KEY\": \"sk-your-openai-api-key\",\n \"GPT_IMAGE_OUTPUT_DIR\": \"C:\\\\Users\\\\username\\\\Pictures\\\\ai-generated-images\"\n }\n }\n }\n}\n```\n |
| Linux/macOS | \n\n\n```json\n{\n \"mcpServers\": {\n \"gpt-image-1\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"@cloudwerxlab/gpt-image-1-mcp\"],\n \"env\": {\n \"OPENAI_API_KEY\": \"sk-your-openai-api-key\",\n \"GPT_IMAGE_OUTPUT_DIR\": \"/home/username/Pictures/ai-generated-images\"\n }\n }\n }\n}\n```\n |
\n 🎨 Core Tools\n
| \n \n 🚀 Key Benefits\n
| \n
\n 📊 Output & Formatting\n
| \n \n ⚙️ Configuration & Handling\n
| \n
| 🖼️ Image Generation | \n✏️ Image Editing | \n
|---|---|
\n
| \n \n
| \n
\n 📂 Storage Location\n
| \n \n 🗂️ File Management\n
| \n
![\"Support](\"https://img.shields.io/badge/Support-Available-brightgreen\"){kind=icon}
\n| Issue | \nSolution | \n
|---|---|
\n 🖼️ MIME Type Errors\nErrors related to image format or MIME type handling \n | \n \n Ensure image files have the correct extension (.png, .jpg, etc.) that matches their actual format. The server uses file extensions to determine MIME types. \n | \n
\n 🔑 API Key Issues\nAuthentication errors with OpenAI API \n | \n \n Verify your OpenAI API key is correct and has access to the gpt-image-1 model. Check for any spaces or special characters that might have been accidentally included. \n | \n
\n 🛠️ Build Errors\nIssues when building from source \n | \n \n Ensure you have the correct TypeScript version installed (v5.3.3 or compatible) and that your | \n
\n 📁 Output Directory Issues\nProblems with saving generated images \n | \n \n Check if the process has write permissions to the configured output directory. Try using an absolute path for | \n
![\"MIT](\"https://img.shields.io/badge/License-MIT-blue.svg\"){kind=icon}
\n\n This project is licensed under the MIT License - see the LICENSE file for details.\n
\n\nThe MIT License is a permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.
\n\nYou are free to:
\nUnder the following terms:
\nLimitations:
\n\n \n ![\"OpenAI\"](\"https://img.shields.io/badge/OpenAI-412991?logo=openai&logoColor=white\"){kind=icon} \n For providing the gpt-image-1 model \n \n | \n \n \n ![\"MCP](\"https://img.shields.io/badge/MCP-Protocol-00A3E0\"){kind=icon} \n For the protocol specification \n \n | \n
\n Report Bug •\n Request Feature •\n Visit Our Website\n
\n\n Developed with ❤️ by CLOUDWERX\n
\n