🚀 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-mcpRelated MCP server: Image Toolkit MCP Server
🔌 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-mcpOder 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
Parameter | Typ | Erforderlich | Beschreibung |
| Schnur | Ja | Die Textbeschreibung des zu generierenden Bildes (max. 32.000 Zeichen) |
| Schnur | NEIN | Bildgröße: „1024 x 1024“ (Standard), „1536 x 1024“ oder „1024 x 1536“ |
| Schnur | NEIN | Bildqualität: „hoch“ (Standard), „mittel“ oder „niedrig“ |
| ganze Zahl | NEIN | Anzahl der zu generierenden Bilder (1-10, Standard: 1) |
| Schnur | NEIN | Hintergrundstil: „transparent“, „undurchsichtig“ oder „auto“ (Standard) |
| Schnur | NEIN | Ausgabeformat: „png“ (Standard), „jpeg“ oder „webp“ |
| ganze Zahl | NEIN | Komprimierungsstufe (0-100, Standard: 0) |
| Schnur | NEIN | Benutzerkennung für die OpenAI-Nutzungsverfolgung |
| Schnur | NEIN | Moderationsstufe: „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
Parameter | Typ | Erforderlich | Beschreibung |
| Zeichenfolge, Objekt oder Array | Ja | Die zu bearbeitenden Bilder (Base64-Zeichenfolge oder Dateipfadobjekt) |
| Schnur | Ja | Die Textbeschreibung der gewünschten Bearbeitung (max. 32.000 Zeichen) |
| Zeichenfolge oder Objekt | NEIN | Die Maske, die zu bearbeitende Bereiche definiert (Base64-Zeichenfolge oder Dateipfadobjekt) |
| Schnur | NEIN | Bildgröße: „1024 x 1024“ (Standard), „1536 x 1024“ oder „1024 x 1536“ |
| Schnur | NEIN | Bildqualität: „hoch“ (Standard), „mittel“ oder „niedrig“ |
| ganze Zahl | NEIN | Anzahl der zu generierenden Bilder (1-10, Standard: 1) |
| Schnur | NEIN | Hintergrundstil: „transparent“, „undurchsichtig“ oder „auto“ (Standard) |
| Schnur | NEIN | Benutzerkennung 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:
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
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