Gpt Image 1 MCP

🚀 @cloudwerxlab/gpt-image-1-mcp

這是一個基於OpenAI gpt-image-1 模型的模型上下文協議（MCP）服務器，可用於生成和編輯圖像，為AI圖像生成提供了便捷的工作流程。

🚀 快速開始

你可以直接使用NPX運行此MCP服務器，而無需進行安裝。在npm上查看。

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

-y 標誌會自動對安裝過程中可能出現的任何提示回答“是”。

📋 前提條件

🔑 環境變量

💻 使用NPX的示例

Linux/macOS

# 設置你的OpenAI API密鑰
export OPENAI_API_KEY=sk-your-openai-api-key

# 可選：設置自定義輸出目錄
export GPT_IMAGE_OUTPUT_DIR=/home/username/Pictures/ai-generated-images

# 使用NPX運行服務器
npx -y @cloudwerxlab/gpt-image-1-mcp

Windows (PowerShell)

# 設置你的OpenAI API密鑰
$env:OPENAI_API_KEY = "sk-your-openai-api-key"

# 可選：設置自定義輸出目錄
$env:GPT_IMAGE_OUTPUT_DIR = "C:\Users\username\Pictures\ai-generated-images"

# 使用NPX運行服務器
npx -y @cloudwerxlab/gpt-image-1-mcp

Windows (Command Prompt)

:: 設置你的OpenAI API密鑰
set OPENAI_API_KEY=sk-your-openai-api-key

:: 可選：設置自定義輸出目錄
set GPT_IMAGE_OUTPUT_DIR=C:\Users\username\Pictures\ai-generated-images

:: 使用NPX運行服務器
npx -y @cloudwerxlab/gpt-image-1-mcp

🔌 與MCP客戶端集成

🛠️ 在MCP客戶端中進行設置

步驟1：找到設置文件

• Roo：c:\Users\<username>\AppData\Roaming\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\mcp_settings.json
• VS Code MCP擴展：查看擴展文檔以獲取設置文件的位置
• Cursor：~/.config/cursor/mcp_settings.json (Linux/macOS) 或 %APPDATA%\Cursor\mcp_settings.json (Windows)
• Augment：~/.config/augment/mcp_settings.json (Linux/macOS) 或 %APPDATA%\Augment\mcp_settings.json (Windows)
• Windsurf：~/.config/windsurf/mcp_settings.json (Linux/macOS) 或 %APPDATA%\Windsurf\mcp_settings.json (Windows)

步驟2：添加配置

將以下配置添加到 mcpServers 對象中：

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

不同操作系統的示例配置

Windows

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

Linux/macOS

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

注意：對於Windows路徑，在JSON中使用雙反斜槓 (\\) 來轉義反斜槓字符。對於Linux/macOS，使用正斜槓 (/)。

✨ 主要特性

🎨 核心工具

• create_image：根據文本提示生成新圖像。
• create_image_edit：使用文本提示和掩碼編輯現有圖像。

🚀 主要優勢

• 與MCP客戶端簡單集成。
• 完全訪問OpenAI的 gpt-image-1 功能。
• 簡化AI圖像生成的工作流程。

💡 增強功能

📊 輸出與格式化

• ✅ 精美格式化輸出：響應包含表情符號和詳細信息。
• ✅ 自動保存圖像：所有生成的圖像都保存到磁盤，便於訪問。
• ✅ 詳細的令牌使用情況：查看每個請求的令牌消耗情況。

⚙️ 配置與處理

• ✅ 可配置的輸出目錄：自定義圖像保存位置。
• ✅ 文件路徑支持：使用文件路徑而不是Base64編碼來編輯圖像。
• ✅ 全面的錯誤處理：詳細的錯誤報告，包含特定的錯誤代碼、描述和故障排除建議。

🔄 工作原理

🖼️ 圖像生成

1. 服務器接收提示和參數。
2. 使用 gpt-image-1 模型調用OpenAI API。
3. API返回Base64編碼的圖像。
4. 服務器將圖像保存到配置的目錄。
5. 返回包含路徑和元數據的格式化響應。

✏️ 圖像編輯

1. 服務器接收圖像、提示和可選的掩碼。
2. 對於文件路徑，讀取併為API準備文件。
3. 使用直接的curl命令進行正確的MIME處理。
4. API返回Base64編碼的編輯後圖像。
5. 服務器將圖像保存到配置的目錄。
6. 返回包含路徑和元數據的格式化響應。

📁 輸出目錄行為

📂 存儲位置

• 🔹 默認位置：用戶圖片文件夾下的 gpt-image-1 子文件夾（例如，Windows上的 C:\Users\username\Pictures\gpt-image-1）。
• 🔹 自定義位置：通過 GPT_IMAGE_OUTPUT_DIR 環境變量設置。
• 🔹 備用位置：./generated-images（如果無法確定圖片文件夾）。

🗂️ 文件管理

• 🔹 目錄創建：如果輸出目錄不存在，將自動創建。
• 🔹 文件命名：圖像以帶時間戳的文件名保存（例如，image-2023-05-05T12-34-56-789Z.png）。
• 🔹 跨平臺：在Windows、macOS和Linux上均可使用，並能正確檢測圖片文件夾。

📦 安裝指南

NPM包

該包可在npm上獲取：@cloudwerxlab/gpt-image-1-mcp

你可以全局安裝它：

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

或者如快速開始部分所示，直接使用npx運行它。

💻 使用示例

工具：create_image

根據文本提示生成新圖像。

參數

示例

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

響應

該工具返回：

• 包含生成圖像詳細信息的格式化文本消息。
• 作為Base64編碼數據的圖像。
• 包括令牌使用情況和文件路徑的元數據。

工具：create_image_edit

使用文本提示和可選的掩碼編輯現有圖像。

參數

使用Base64編碼圖像的示例

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

使用文件路徑的示例

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

響應

該工具返回：

• 包含編輯後圖像詳細信息的格式化文本消息。
• 作為Base64編碼數據的編輯後圖像。
• 包括令牌使用情況和文件路徑的元數據。

🔧 故障排除

🚨 常見問題

🔍 錯誤處理和報告

MCP服務器包含全面的錯誤處理，當出現問題時提供詳細信息。當發生錯誤時：

1. 錯誤格式：所有錯誤都返回以下內容：
   • 描述問題的清晰錯誤消息。
   • 特定的錯誤代碼或類型。
   • 可用時提供有關錯誤的額外上下文。
2. AI助手行為：當與AI助手一起使用此MCP服務器時：
   • AI將始終報告完整的錯誤消息，以幫助進行故障排除。
   • AI將用通俗易懂的語言解釋錯誤的可能原因。
   • AI將建議解決問題的具體步驟。

📄 許可證

本項目採用MIT許可證 - 有關詳細信息，請參閱 LICENSE 文件。

許可證摘要

MIT許可證是一種寬鬆的許可證，簡潔明瞭。它允許人們在適當歸因且無擔保的情況下對代碼進行任何操作。

你可以自由地：

• 商業使用該軟件。
• 修改該軟件。
• 分發該軟件。
• 私下使用和修改該軟件。

在以下條件下：

• 在所有副本或實質性使用的作品中包含原始版權聲明和許可證聲明。

限制：

• 作者不提供軟件的任何擔保，也不對任何損害負責。

🙏 致謝

感謝以下方面的支持：

• OpenAI：提供 gpt-image-1 模型。
• model-context-protocol/mcp：提供協議規範。

如果你發現任何問題或有功能請求，請 報告錯誤 或 請求功能。訪問 我們的網站 瞭解更多信息。

本項目由 CLOUDWERX 用心開發。