Gpt Image 1 MCP

🚀 @cloudwerxlab/gpt-image-1-mcp

このプロジェクトは、OpenAIのgpt-image-1モデルを使用して画像を生成および編集するためのModel Context Protocol (MCP)サーバーです。AIによる画像生成のワークフローを合理化し、MCPクライアントとの統合が容易です。

🚀 クイックスタート

このMCPサーバーは、インストールせずに直接NPXを使用して実行できます。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画像生成のための合理化されたワークフロー

💡 拡張機能

📊 出力とフォーマット

• ✅ 美しくフォーマットされた出力: 応答には絵文字と詳細情報が含まれます。
• ✅ 自動画像保存: すべての生成された画像はディスクに保存され、簡単にアクセスできます。
• ✅ 詳細なトークン使用状況: 各リクエストのトークン消費量を表示します。

⚙️ 設定と処理

• ✅ 設定可能な出力ディレクトリ: 画像を保存する場所をカスタマイズできます。
• ✅ ファイルパスサポート: ベース64エンコードではなくファイルパスを使用して画像を編集できます。
• ✅ 包括的なエラーハンドリング: 特定のエラーコード、説明、およびトラブルシューティングの提案を含む詳細なエラーレポート。

🔄 仕組み

🖼️ 画像生成

1. サーバーがプロンプトとパラメータを受け取ります。
2. gpt-image-1モデルを使用してOpenAI APIを呼び出します。
3. APIからベース64エンコードされた画像が返されます。
4. サーバーが画像を設定されたディレクトリに保存します。
5. パスとメタデータを含むフォーマットされた応答を返します。

✏️ 画像編集

1. サーバーが画像、プロンプト、およびオプションのマスクを受け取ります。
2. ファイルパスの場合は、API用にファイルを読み取り、準備します。
3. 適切なMIMEハンドリングのために直接curlコマンドを使用します。
4. APIからベース64エンコードされた編集済み画像が返されます。
5. サーバーが画像を設定されたディレクトリに保存します。
6. パスとメタデータを含むフォーマットされた応答を返します。

📁 出力ディレクトリの動作

📂 保存場所

• 🔹 デフォルトの場所: ユーザーのPicturesフォルダ内のgpt-image-1サブフォルダ（例: Windowsの場合はC:\Users\username\Pictures\gpt-image-1）
• 🔹 カスタム場所: GPT_IMAGE_OUTPUT_DIR環境変数で設定します。
• 🔹 フォールバック場所: ./generated-images（Picturesフォルダが決定できない場合）

🗂️ ファイル管理

• 🔹 ディレクトリ作成: 出力ディレクトリが存在しない場合は自動的に作成します。
• 🔹 ファイル名付け: 画像はタイムスタンプ付きのファイル名で保存されます（例: image-2023-05-05T12-34-56-789Z.png）
• 🔹 クロスプラットフォーム: Windows、macOS、およびLinuxで適切なPicturesフォルダ検出機能を備えています。

📦 インストール

NPMパッケージ

このパッケージはnpmで入手できます: @cloudwerxlab/gpt-image-1-mcp

グローバルにインストールすることも、クイックスタートセクションで示されているようにnpxで直接実行することもできます。

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

ツール: 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>

応答

このツールは以下を返します:

• 生成された画像の詳細を含むフォーマットされたテキストメッセージ
• ベース64エンコードされたデータとしての画像
• トークン使用状況とファイルパスを含むメタデータ

ツール: create_image_edit

テキストプロンプトとオプションのマスクに基づいて既存の画像を編集します。

パラメータ

ベース64エンコードされた画像を使用した例

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

応答

このツールは以下を返します:

• 編集された画像の詳細を含むフォーマットされたテキストメッセージ
• ベース64エンコードされたデータとしての編集された画像
• トークン使用状況とファイルパスを含むメタデータ

🔧 トラブルシューティング

🚨 一般的な問題と解決策

🔍 エラーハンドリングとレポート

MCPサーバーには包括的なエラーハンドリングが含まれており、問題が発生したときに詳細な情報を提供します。エラーが発生した場合:

1. エラー形式: すべてのエラーは以下を含んで返されます:
   • 何が問題であったかを説明する明確なエラーメッセージ
   • 特定のエラーコードまたはタイプ
   • 利用可能な場合のエラーに関する追加のコンテキスト
2. AIアシスタントの動作: このMCPサーバーをAIアシスタントとともに使用する場合:
   • AIは常に完全なエラーメッセージを報告してトラブルシューティングを支援します。
   • AIはエラーの考えられる原因を平易な言葉で説明します。
   • AIは問題を解決するための具体的な手順を提案します。

📄 ライセンス

このプロジェクトはMITライセンスの下でライセンスされています - 詳細についてはLICENSEファイルを参照してください。

🙏 謝辞

このプロジェクトは、以下のサービスや技術によって可能になっています。

• OpenAI：gpt-image-1モデルの提供
• Model Context Protocol (MCP)：プロトコル仕様の提供

フィードバック

• バグ報告
• 機能リクエスト
• 公式ウェブサイト

このプロジェクトは CLOUDWERX によって開発されました。