OpenAI Image Generation MCP

OpenAI 图像生成 MCP

用于 OpenAI 图像生成 API 的模型上下文协议（MCP）服务。此 MCP 可让 Claude 等 AI 助手使用 OpenAI 的 GPT-image-1 模型生成和编辑图像。

目录

• 功能
• 安装
• 快速开始
• 配置
• 详细文档
• 许可证

功能

• 使用 OpenAI 图像生成模型生成图像
• 使用文本提示词和可选蒙版编辑现有图像
• 自动将生成的图像保存到本地存储
• 可选择将生成的图像上传到 Cloudflare ImgBed
• 提供健康检查端点以验证服务状态
• 支持多种提供 API 密钥的方式（环境变量、命令行、直接提供）

安装

1. 克隆仓库并安装依赖项：

git clone https://github.com/yourusername/openai-image-gen-mcp.git
cd openai-image-gen-mcp
npm install

2. 构建 TypeScript 项目：

npm run build

快速开始

1. 使用运行脚本（推荐用于生产环境）

启动功能完整的 MCP 服务最简单的方式：

./run-with-key.sh

此脚本中内置了 API 密钥，并会启动包含全部功能的 MCP 服务。

2. 使用直接提供的 API 密钥（用于测试）

node hardcoded-key.js

这是一个简化版本，直接在代码中内置 API 密钥。

3. 使用环境变量

export OPENAI_API_KEY=your-api-key
./start.sh

配置

Claude MCP 配置

要将 Claude 连接到此 MCP，请使用此配置文件：

{
  "mcpServers": {
    "openai-image-gen": {
      "command": "node",
      "args": ["/Users/jerry/openai-image-gen-mcp/build/index.js"]
    }
  }
}

⚠️ 重要提示：生产环境请使用功能完整的编译版本（build/index.js）。简化版本仅供测试和学习使用。

可用工具

此 MCP 为 Claude 提供以下工具：

1. oai_generate_image - 根据文本提示词生成图像
2. oai_edit_image - 根据文本提示词编辑现有图像
3. health_check - 验证服务的健康状态

在 Claude 中的使用示例：

Generate an image of a sunset over mountains with a lake in the foreground.

Claude 会使用相应的 MCP 工具创建图像。

详细文档

如需了解更多信息，请参阅：

• 架构 - 系统设计和组件
• 流水线 - 开发与请求处理流水线
• 指南 - 最佳实践和使用指南
• 说明 - 代码和 API 的详细说明

目录结构

openai-image-gen-mcp/
├── build/              # Compiled JavaScript code
├── docs/               # Documentation files
├── output/             # Generated images
├── src/                # TypeScript source code
│   ├── config.js       # Configuration management
│   └── index.ts        # Main MCP server implementation
├── *.sh                # Helper scripts
├── *.js                # Simplified versions and utilities
└── *.json              # Configuration files

故障排除

如果遇到问题：

1. 检查 API 密钥是否有效且格式正确
2. 确保输出目录存在且可写
3. 运行健康检查以验证服务状态
4. 查看日志以获取详细的错误信息
5. 尝试使用简化版本来排查问题

如需更多帮助，请参阅指南中的故障排除部分。