@cloudwerxlab/gpt-image-1-mcp について
@cloudwerxlab/gpt-image-1-mcpは、OpenAIのgpt-image-1で画像を生成・編集するMCPサーバーです。画像をローカルに保存し、パスや使用量の情報を返します。
主な機能
- 01プロンプトから画像を生成
- 02プロンプトと任意のマスクで画像を編集
- 03編集時に画像ファイルパスを指定
- 04出力先ディレクトリを設定して保存
- 05画像パスとトークン使用量を返却
活用シーン
- 01MCPクライアントで説明文から画像を作成
- 02プロンプトとマスクで画像を修正
- 03生成画像を指定フォルダーに保存
MCP 対応
MCPクライアントにcreate_imageとcreate_image_editツールを提供します。gpt-image-1を利用できるOpenAI APIキーが必要です。
設定
ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。
ツール
ローカルサーバーのツールはマシン上で起動して初めて取得できます。メンテナーはまだツール一覧を提供していません。
詳細
@cloudwerxlab/gpt-image-1-mcp
OpenAI の gpt-image-1 モデルを使用して画像を生成・編集するための Model Context Protocol(MCP)サーバーです。
🚀 クイックスタート
インストールせずに、NPX を使ってこの MCP サーバーを直接実行できます。npm で見る。
npx -y @cloudwerxlab/gpt-image-1-mcp
-y フラグを指定すると、インストール中に表示される可能性のあるプロンプトに自動的に「yes」と回答します。
📋 前提条件
|
Node.js(v14 以降) |
gpt-image-1 を利用できる OpenAI API キー |
🔑 環境変数
| 変数 | 必須 | 説明 |
|---|---|---|
OPENAI_API_KEY | ✅ はい | gpt-image-1 モデルを利用できる OpenAI API キー |
GPT_IMAGE_OUTPUT_DIR | ❌ いいえ | 生成した画像を保存するカスタムディレクトリ(デフォルトでは、ユーザーの Pictures フォルダー内の gpt-image-1 サブフォルダーに保存) |
💻 NPX を使った実行例
| オペレーティングシステム | コマンドラインの例 |
|---|---|
| Linux/macOS |
|
| Windows(PowerShell) |
|
| Windows(コマンドプロンプト) |
|
🔌 MCP クライアントとの統合
ステップ 1:設定ファイルの場所を確認
|
ステップ 2:設定を追加次の設定を |
{
"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 |
|
| Linux/macOS |
|
注:Windows のパスでは、JSON 内でバックスラッシュ文字をエスケープするために、バックスラッシュを 2 つ(
\\)使用してください。Linux/macOS ではスラッシュ(/)を使用してください。
✨ 機能
🎨 コアツール
|
🚀 主なメリット
|
💡 強化された機能
📊 出力とフォーマット
|
⚙️ 設定と処理
|
| 🖼️ 画像生成 | ✏️ 画像編集 |
|---|---|
|
|
📁 出力ディレクトリの動作
📂 保存場所
|
🗂️ ファイル管理
|
インストールと使用方法
NPM パッケージ
このパッケージは npm で入手できます: @cloudwerxlab/gpt-image-1-mcp
グローバルにインストールできます:
npm install -g @cloudwerxlab/gpt-image-1-mcp
または、「クイックスタート」セクションに記載のとおり、npx で直接実行できます。
ツール:create_image
テキストプロンプトに基づいて新しい画像を生成します。
パラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
prompt | string | はい | 生成する画像のテキストによる説明(最大 32,000 文字) |
size | string | いいえ | 画像サイズ:「1024x1024」(デフォルト)、「1536x1024」、または「1024x1536」 |
quality | string | いいえ | 画像品質:「high」(デフォルト)、「medium」、または「low」 |
n | integer | いいえ | 生成する画像の数(1~10、デフォルト:1) |
background | string | いいえ | 背景スタイル:「transparent」、「opaque」、または「auto」(デフォルト) |
output_format | string | いいえ | 出力形式:「png」(デフォルト)、「jpeg」、または「webp」 |
output_compression | integer | いいえ | 圧縮レベル(0~100、デフォルト:0) |
user | string | いいえ | OpenAI の利用状況を追跡するためのユーザー識別子 |
moderation | string | いいえ | モデレーションレベル:「low」または「auto」(デフォルト) |
例
<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
テキストプロンプトと任意のマスクに基づいて、既存の画像を編集します。
パラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
image | string、object、または array | はい | 編集する画像(base64 文字列またはファイルパスオブジェクト) |
prompt | string | はい | 希望する編集内容のテキスト説明(最大 32,000 文字) |
mask | string または object | いいえ | 編集領域を定義するマスク(base64 文字列またはファイルパスオブジェクト) |
size | string | いいえ | 画像サイズ:「1024x1024」(デフォルト)、「1536x1024」、または「1024x1536」 |
quality | string | いいえ | 画像品質:「high」(デフォルト)、「medium」、または「low」 |
n | integer | いいえ | 生成する画像の数(1~10、デフォルト:1) |
background | string | いいえ | 背景スタイル:「transparent」、「opaque」、または「auto」(デフォルト) |
user | string | いいえ | OpenAI の使用状況追跡用ユーザー識別子 |
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 エンコードされたデータとしての編集済み画像
- トークン使用量やファイルパスなどのメタデータ
🔧 トラブルシューティング
🚨 よくある問題
| 問題 | 解決策 |
|---|---|
🖼️ MIME タイプのエラー画像形式または MIME タイプの処理に関するエラー |
画像ファイルの拡張子(.png、.jpg など)が実際の形式と一致していることを確認してください。サーバーはファイル拡張子を使用して MIME タイプを判定します。 |
🔑 API キーの問題OpenAI API の認証エラー |
OpenAI API キーが正しく、gpt-image-1 モデルへのアクセス権があることを確認してください。誤って含まれた可能性のある空白や特殊文字がないか確認してください。 |
🛠️ ビルドエラーソースからビルドする際の問題 |
適切な TypeScript バージョン(v5.3.3 または互換バージョン)がインストールされており、 |
📁 出力ディレクトリの問題生成した画像の保存に関する問題 |
プロセスに設定済みの出力ディレクトリへの書き込み権限があるか確認してください。相対パスが機能しない場合は、 |
🔍 エラー処理と報告
MCP サーバーには包括的なエラー処理が含まれており、問題が発生した際に詳細な情報を提供します。エラーが発生すると:
-
エラー形式:すべてのエラーには以下が含まれます。
- 問題の内容を説明する明確なエラーメッセージ
- エラーコードまたはエラータイプ
- 入手可能な場合は、エラーに関する追加のコンテキスト
-
AI アシスタントの動作:この MCP サーバーを AI アシスタントと併用する場合:
- AI はトラブルシューティングに役立つよう、エラーメッセージ全体を必ず報告します
- AI はエラーの考えられる原因を平易な言葉で説明します
- AI は問題を解決するための具体的な手順を提案します
📄 ライセンス
このプロジェクトはMITライセンスのもとでライセンスされています。詳細についてはLICENSEファイルをご覧ください。
ライセンスの概要
MITライセンスは、簡潔で要点を押さえた寛容なライセンスです。適切なクレジット表記を行い、保証なしであれば、誰でもこのコードを自由に利用できます。
次のことが自由にできます:
- ソフトウェアを商用利用する
- ソフトウェアを改変する
- ソフトウェアを配布する
- ソフトウェアを非公開で利用・改変する
ただし、次の条件に従う必要があります:
- 作品のすべてのコピーまたは実質的な利用に、元の著作権表示とライセンス表示を含める
制限事項:
- 作者はソフトウェアを無保証で提供し、いかなる損害についても責任を負いません
🙏 謝辞
❤️ を込めて開発:CLOUDWERX
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。