🚀 Быстрый старт
npx -y @cloudwerxlab/gpt-image-1-mcp📋 Предварительные условия
🔑 Переменные среды
💻 Пример использования с 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
🔌 Интеграция с клиентами MCP
🛠️ Настройка в клиенте MCP
{
"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"
}
}
}
}Примеры конфигураций для разных операционных систем
{
"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"
}
}
}
}Примечание : Для путей Windows используйте двойные обратные косые черты (
\\), чтобы экранировать символ обратной косой черты в JSON. Для Linux/macOS используйте прямые косые черты (/).
✨ Особенности
💡 Расширенные возможности
🔄 Как это работает
📁 Поведение выходного каталога
Установка и использование
Пакет НПМ
Этот пакет доступен на npm: @cloudwerxlab/gpt-image-1-mcp
Вы можете установить его глобально:
npm install -g @cloudwerxlab/gpt-image-1-mcpИли запустите его напрямую с помощью npx, как показано в разделе «Быстрый старт».
Инструмент: create_image
Создает новое изображение на основе текстовой подсказки.
Параметры
Параметр | Тип | Необходимый | Описание |
| нить | Да | Текстовое описание изображения, которое необходимо сгенерировать (макс. 32 000 символов) |
| нить | Нет | Размер изображения: «1024x1024» (по умолчанию), «1536x1024» или «1024x1536» |
| нить | Нет | Качество изображения: «высокое» (по умолчанию), «среднее» или «низкое» |
| целое число | Нет | Количество изображений для генерации (1-10, по умолчанию: 1) |
| нить | Нет | Стиль фона: «прозрачный», «непрозрачный» или «авто» (по умолчанию) |
| нить | Нет | Формат вывода: «png» (по умолчанию), «jpeg» или «webp» |
| целое число | Нет | Уровень сжатия (0-100, по умолчанию: 0) |
| нить | Нет | Идентификатор пользователя для отслеживания использования OpenAI |
| нить | Нет | Уровень модерации: «низкий» или «авто» (по умолчанию) |
Пример
<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 или объект пути к файлу) |
| нить | Да | Текстовое описание желаемой правки (макс. 32 000 символов) |
| строка или объект | Нет | Маска, определяющая области для редактирования (строка base64 или объект пути к файлу) |
| нить | Нет | Размер изображения: «1024x1024» (по умолчанию), «1536x1024» или «1024x1536» |
| нить | Нет | Качество изображения: «высокое» (по умолчанию), «среднее» или «низкое» |
| целое число | Нет | Количество изображений для генерации (1-10, по умолчанию: 1) |
| нить | Нет | Стиль фона: «прозрачный», «непрозрачный» или «авто» (по умолчанию) |
| нить | Нет | Идентификатор пользователя для отслеживания использования 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
Метаданные, включая использование токенов и пути к файлам
🔧 Устранение неполадок
🚨 Распространенные проблемы
🔍 Обработка ошибок и отчетность
Сервер MCP включает в себя комплексную обработку ошибок, которая предоставляет подробную информацию, когда что-то идет не так. Когда возникает ошибка:
Формат ошибки : Все ошибки возвращаются с:
Четкое сообщение об ошибке, описывающее, что пошло не так
Конкретный код или тип ошибки
Дополнительный контекст об ошибке, если он доступен
Поведение помощника на основе ИИ : При использовании этого сервера MCP с помощниками на основе ИИ:
ИИ всегда будет сообщать полное сообщение об ошибке, чтобы помочь в устранении неполадок.
ИИ объяснит вероятную причину ошибки простым языком
ИИ предложит конкретные шаги для решения проблемы
