Skip to main content
Glama
deenesjakoruzh
CLOUDWERX-DEV

GPT Image 1 MCP

by CLOUDWERX-DEV
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

🚀 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

Related MCP server: OpenAI 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

Parameter

Typ

Erforderlich

Beschreibung

prompt

Schnur

Ja

Die Textbeschreibung des zu generierenden Bildes (max. 32.000 Zeichen)

size

Schnur

NEIN

Bildgröße: „1024 x 1024“ (Standard), „1536 x 1024“ oder „1024 x 1536“

quality

Schnur

NEIN

Bildqualität: „hoch“ (Standard), „mittel“ oder „niedrig“

n

ganze Zahl

NEIN

Anzahl der zu generierenden Bilder (1-10, Standard: 1)

background

Schnur

NEIN

Hintergrundstil: „transparent“, „undurchsichtig“ oder „auto“ (Standard)

output_format

Schnur

NEIN

Ausgabeformat: „png“ (Standard), „jpeg“ oder „webp“

output_compression

ganze Zahl

NEIN

Komprimierungsstufe (0-100, Standard: 0)

user

Schnur

NEIN

Benutzerkennung für die OpenAI-Nutzungsverfolgung

moderation

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

image

Zeichenfolge, Objekt oder Array

Ja

Die zu bearbeitenden Bilder (Base64-Zeichenfolge oder Dateipfadobjekt)

prompt

Schnur

Ja

Die Textbeschreibung der gewünschten Bearbeitung (max. 32.000 Zeichen)

mask

Zeichenfolge oder Objekt

NEIN

Die Maske, die zu bearbeitende Bereiche definiert (Base64-Zeichenfolge oder Dateipfadobjekt)

size

Schnur

NEIN

Bildgröße: „1024 x 1024“ (Standard), „1536 x 1024“ oder „1024 x 1536“

quality

Schnur

NEIN

Bildqualität: „hoch“ (Standard), „mittel“ oder „niedrig“

n

ganze Zahl

NEIN

Anzahl der zu generierenden Bilder (1-10, Standard: 1)

background

Schnur

NEIN

Hintergrundstil: „transparent“, „undurchsichtig“ oder „auto“ (Standard)

user

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:

  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

Available Tools

2 tools
create_imageD
ParametersJSON Schema
NameRequiredDescriptionDefault
promptYes
backgroundNo
nNo
output_compressionNo
output_formatNo
qualityNo
sizeNo
userNo
moderationNo

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_image_editD
ParametersJSON Schema
NameRequiredDescriptionDefault
imageYes
promptYes
backgroundNo
maskNo
nNo
qualityNo
sizeNo
userNo

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updates
    • First observedcreate_image
    • First observedcreate_image_edit
Deploy Server
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

TDQS

D1.5/5.0

Scored across 2 tools

Disambiguation2/5

The two tools have overlapping purposes—both involve creating images—and without descriptions, it's unclear how they differ. 'create_image_edit' suggests editing an existing image, but this could easily be confused with the base 'create_image' tool, leading to potential misselection.

Naming Consistency5/5

Both tools follow a consistent verb_noun pattern with 'create_image' as the base, and 'create_image_edit' extends this logically. The naming is predictable and clear, with no deviations in style or convention.

Tool Count2/5

With only 2 tools, the server feels thin for an image-related domain, which typically requires operations like listing, retrieving, updating, or deleting images. This limited set may not support common workflows, making it under-scoped.

Completeness1/5

The tool surface is severely incomplete for an image server; there are no tools for reading, updating, deleting, or managing images beyond creation and editing. This will cause significant agent failures in handling image lifecycles or varied tasks.

Maintenance

ActivityInactive
ResponsivenessUnresponsive

Resources

Related MCP Connectors

Related MCP Servers

Appeared in Searches