关于 @cloudwerxlab/gpt-image-1-mcp
@cloudwerxlab/gpt-image-1-mcp 是基于 OpenAI gpt-image-1 的 MCP 服务，可生成和编辑图像，并将文件保存到本地、返回路径与用量信息。
主要功能
- 01根据提示词生成图像
- 02通过提示词和可选蒙版编辑图像
- 03编辑时支持图像文件路径
- 04将输出保存到可配置目录
- 05返回图像路径和令牌用量
适用场景
- 01在 MCP 客户端中按描述生成图像
- 02使用提示词和蒙版修改图像
- 03将生成的图像保存到指定目录
MCP 相关
向 MCP 客户端提供 create_image 和 create_image_edit 工具。需要有权访问 gpt-image-1 的 OpenAI API 密钥。
配置
本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。
工具
还没有获取到工具列表
本地服务需要在你的电脑上运行后才能读取工具，维护者暂未提供工具列表。
详细介绍
@cloudwerxlab/gpt-image-1-mcp
一个用于使用 OpenAI gpt-image-1 模型生成和编辑图像的模型上下文协议（MCP）服务。
🚀 快速开始
无需安装，即可使用 NPX 直接运行此 MCP 服务。在 npm 上查看。
npx -y @cloudwerxlab/gpt-image-1-mcp
-y 标志会在安装过程中自动对可能出现的提示回答“是”。
📋 先决条件
Node.js（v14 或更高版本） |
拥有 gpt-image-1 使用权限的 OpenAI API 密钥 |
🔑 环境变量
| 变量 | 必需 | 说明 |
|---|---|---|
OPENAI_API_KEY | ✅ 是 | 拥有 gpt-image-1 模型使用权限的 OpenAI API 密钥 |
GPT_IMAGE_OUTPUT_DIR | ❌ 否 | 用于保存生成图像的自定义目录（默认位于用户的图片文件夹下的 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 中转义反斜杠字符。对于 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 编码的编辑后图像数据
- 包含 token 用量和文件路径的元数据
🔧 故障排除
🚨 常见问题
| 问题 | 解决方案 |
|---|---|
🖼️ 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 倾心打造 ❤️
评论
支持 Markdown
一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。