article
README
🚀 openai-gpt-image-mcp
openai-gpt-image-mcp 是一个用于OpenAI的GPT - 4o/gpt - image - 1图像生成和编辑API的Model Context Protocol (MCP)工具服务器。它可以使用文本提示生成图像,还能通过高级提示控制实现对图像的编辑,并且支持Claude Desktop、Cursor、VSCode、Windsurf等与MCP兼容的客户端。
🚀 快速开始
安装
git clone https://github.com/SureScaleAI/openai-gpt-image-mcp.git
cd openai-gpt-image-mcp
yarn install
yarn build
配置
添加到Claude Desktop或VSCode(包括Cursor/Windsurf)配置中:
{
"mcpServers": {
"openai-gpt-image-mcp": {
"command": "node",
"args": ["/absolute/path/to/dist/index.js"],
"env": { "OPENAI_API_KEY": "sk-..." }
}
}
}
✨ 主要特性
- create - image:使用高级选项(大小、质量、背景等)从提示生成图像。
- edit - image:使用提示和可选遮罩编辑或扩展图像,支持文件路径和base64输入。
- 文件输出:直接将生成的图像保存到磁盘,或接收为base64。
🔧 技术细节
高级功能
- 对于
create - image,设置n以一次生成多达10张图像。 - 对于
edit - image,提供一个遮罩图像(文件路径或base64)来控制编辑应用的位置。 - 查看
src/index.ts获取所有选项。
开发相关
- TypeScript源代码:
src/index.ts - 构建:
yarn build - 运行:
node dist/index.js
📚 详细文档
问题排查
- 确保您的
OPENAI_API_KEY有效,并且具有图像API访问权限。 - 您必须拥有一个验证的OpenAI组织。验证后,图像API访问权限可能需要15–20分钟才能激活。
- 文件路径必须是绝对路径。
- Unix/macOS/Linux:以
/开头(例如/path/to/image.png) - Windows:驱动器号后跟
:(例如C:/path/to/image.png或C:\path\to\image.png)
- Unix/macOS/Linux:以
- 对于文件输出,确保目录可写。
- 如果看到与文件类型相关的错误,请检查图像文件的扩展名和格式。
局限性和大文件处理
- 1MB有效载荷限制:MCP客户端(包括Claude Desktop)对工具响应有一个严格的1MB上限。大型图像(尤其是高分辨率或多张图像)很容易因返回base64而超出此限制。
- 自动切换到文件输出:如果总图像大小超过1MB,工具将自动将图像保存到磁盘并返回文件路径,而不是base64。这确保了兼容性并防止
结果超过最大长度1048576之类的错误。 - 默认文件位置:如果您未指定
file_output路径,图像将保存到/tmp(或由MCP_HF_WORK_DIR环境变量设置的目录)中的唯一文件名。 - 环境变量:
MCP_HF_WORK_DIR:设置此变量以控制大图像和文件输出的位置。示例:export MCP_HF_WORK_DIR=/your/desired/dir
- 最佳实践:对于大型或生产用途的图像,始终使用文件输出,并确保客户端配置为处理文件路径。
参考资料
📄 许可证
本项目采用MIT许可证。
💡 使用建议
如果有任何问题或反馈,请联系SureScale.ai。
微信扫一扫