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.

🚀 Schnellstart

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

📋 Voraussetzungen

🔑 Umgebungsvariablen

💻 Beispielverwendung mit 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 mit MCP-Clients

🛠️ Einrichten in einem 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" } } } }
Beispielkonfigurationen für verschiedene Betriebssysteme
{ "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" } } } }

Hinweis : Verwenden Sie für Windows-Pfade doppelte Backslashes ( \\ ), um den Backslash in JSON zu maskieren. Verwenden Sie unter Linux/macOS Schrägstriche ( / ).

✨ Funktionen

💡 Erweiterte Funktionen

🔄 So funktioniert es

📁 Verhalten des Ausgabeverzeichnisses

Installation und Verwendung

NPM-Paket

Dieses Paket ist auf npm verfügbar: @cloudwerxlab/gpt-image-1-mcp

Sie können es global installieren:

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

Oder führen Sie es direkt mit npx aus, wie im Abschnitt „Schnellstart“ gezeigt.

Werkzeug: create_image

Generiert ein neues Bild basierend auf einer Textaufforderung.

Parameter
ParameterTypErforderlichBeschreibung
promptSchnurJaDie Textbeschreibung des zu generierenden Bildes (max. 32.000 Zeichen)
sizeSchnurNEINBildgröße: „1024 x 1024“ (Standard), „1536 x 1024“ oder „1024 x 1536“
qualitySchnurNEINBildqualität: „hoch“ (Standard), „mittel“ oder „niedrig“
nganze ZahlNEINAnzahl der zu generierenden Bilder (1-10, Standard: 1)
backgroundSchnurNEINHintergrundstil: „transparent“, „undurchsichtig“ oder „auto“ (Standard)
output_formatSchnurNEINAusgabeformat: „png“ (Standard), „jpeg“ oder „webp“
output_compressionganze ZahlNEINKomprimierungsstufe (0-100, Standard: 0)
userSchnurNEINBenutzerkennung für die OpenAI-Nutzungsverfolgung
moderationSchnurNEINModerationsstufe: „niedrig“ oder „auto“ (Standard)
Beispiel
<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>
Antwort

Das Tool gibt Folgendes zurück:

  • Eine formatierte Textnachricht mit Details zu den generierten Bildern
  • Das/Die Bild(er) als Base64-kodierte Daten
  • Metadaten, einschließlich Token-Nutzung und Dateipfade

Werkzeug: create_image_edit

Bearbeitet ein vorhandenes Bild basierend auf einer Textaufforderung und einer optionalen Maske.

Parameter
ParameterTypErforderlichBeschreibung
imageZeichenfolge, Objekt oder ArrayJaDie zu bearbeitenden Bilder (Base64-Zeichenfolge oder Dateipfadobjekt)
promptSchnurJaDie Textbeschreibung der gewünschten Bearbeitung (max. 32.000 Zeichen)
maskZeichenfolge oder ObjektNEINDie Maske, die zu bearbeitende Bereiche definiert (Base64-Zeichenfolge oder Dateipfadobjekt)
sizeSchnurNEINBildgröße: „1024 x 1024“ (Standard), „1536 x 1024“ oder „1024 x 1536“
qualitySchnurNEINBildqualität: „hoch“ (Standard), „mittel“ oder „niedrig“
nganze ZahlNEINAnzahl der zu generierenden Bilder (1-10, Standard: 1)
backgroundSchnurNEINHintergrundstil: „transparent“, „undurchsichtig“ oder „auto“ (Standard)
userSchnurNEINBenutzerkennung für die OpenAI-Nutzungsverfolgung
Beispiel mit Base64-codiertem Bild
<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>
Beispiel mit Dateipfad
<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>
Antwort

Das Tool gibt Folgendes zurück:

  • Eine formatierte Textnachricht mit Details zu den bearbeiteten Bildern
  • Die bearbeiteten Bilder als Base64-kodierte Daten
  • Metadaten, einschließlich Token-Nutzung und Dateipfade

🔧 Fehlerbehebung

🚨 Häufige Probleme

🔍 Fehlerbehandlung und -berichterstattung

Der MCP-Server verfügt über eine umfassende Fehlerbehandlung, die detaillierte Informationen liefert, wenn etwas schief geht. Wenn ein Fehler auftritt:

  1. Fehlerformat : Alle Fehler werden mit folgendem zurückgegeben:
    • Eine klare Fehlermeldung, die beschreibt, was schief gelaufen ist
    • Der spezifische Fehlercode oder -typ
    • Zusätzlicher Kontext zum Fehler, sofern verfügbar
  2. Verhalten des KI-Assistenten : Bei Verwendung dieses MCP-Servers mit KI-Assistenten:
    • Die KI meldet immer die vollständige Fehlermeldung, um bei der Fehlerbehebung zu helfen
    • Die KI erklärt die wahrscheinliche Fehlerursache in einfacher Sprache
    • Die KI schlägt konkrete Schritte zur Lösung des Problems vor

📄 Lizenz

🙏 Danksagungen

You must be authenticated.

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

Ein Model Context Protocol-Server, der das Generieren und Bearbeiten von Bildern mithilfe des gpt-image-1-Modells von OpenAI ermöglicht, sodass KI-Assistenten Bilder anhand von Textaufforderungen erstellen und ändern können.

  1. 📋 Voraussetzungen
    1. 🔑 Umgebungsvariablen
      1. 💻 Beispielverwendung mit NPX
        1. 🔌 Integration mit MCP-Clients
          1. 🛠️ Einrichten in einem MCP-Client
        2. ✨ Funktionen
          1. 💡 Erweiterte Funktionen
        3. 🔄 So funktioniert es
          1. 📁 Verhalten des Ausgabeverzeichnisses
        4. Installation und Verwendung
          1. NPM-Paket
          2. Werkzeug: create_image
          3. Werkzeug: create_image_edit
        5. 🔧 Fehlerbehebung
          1. 🚨 Häufige Probleme
          2. 🔍 Fehlerbehandlung und -berichterstattung
        6. 📄 Lizenz
          1. 🙏 Danksagungen

            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