MCP OpenAI Image Generation Server

MCP OpenAI Image Generation Server

本项目提供基于 Model Context Protocol (MCP) 的服务实现，用于封装 OpenAI 的图像生成和编辑 API（请参阅 OpenAI 文档）。

功能

• 通过 MCP 工具提供 OpenAI 图像生成能力。
• 支持使用 DALL-E 2、DALL-E 3 和 gpt-image-1 等模型进行 text-to-image 生成（如果可用或已启用）。
• 支持使用 DALL-E 2 和 gpt-image-1 进行 image-to-image 编辑（如果可用或已启用）。
• 可通过环境变量和命令行参数进行配置。
• 支持尺寸、质量、风格、格式等多种参数。
• 将生成或编辑后的图像保存到临时文件，并返回文件路径和 base64 数据。

以下示例展示了如何在 Cursor 中直接使用通过 MCP 集成的 text-to-image 工具生成图像：

使用 npx 快速运行

你可以使用 npx 直接从 npm 运行服务（需要 Node.js 和 npm）：

npx imagegen-mcp [options]

有关选项和本地运行的更多详情，请参阅运行服务部分。

前提条件

• Node.js（建议使用 v18 或更高版本）
• npm 或 yarn
• OpenAI API 密钥

与 Cursor 集成

你可以轻松地将此服务与 Cursor 集成，以便直接在编辑器中使用图像生成功能：

1. 打开 Cursor 设置：

   • 前往 File > Preferences > Cursor Settings（或使用快捷键 Ctrl+, / Cmd+,）。

2. 前往 MCP 设置：

   • 在设置搜索栏中搜索“MCP”。
   • 找到“Model Context Protocol: Custom Servers”设置。

3. 添加自定义服务：

   • 点击“Edit in settings.json”。
   • 在 mcpServers 数组中添加一项。内容大致如下：

   "mcpServers": [
       "image-generator-gpt-image": {
           "command": "npx imagegen-mcp --models gpt-image-1",
           "env": {
               "OPENAI_API_KEY": "xxx"
           }
       }
     // ... any other custom servers ...
   ]
   

   • 自定义命令：
     • 你可以在 command 字段中更改 --models 参数，指定要让 Cursor 使用的模型（例如 --models dall-e-3 或 --models gpt-image-1）。请确保你的 OpenAI API 密钥有权访问所选模型。

4. 保存设置：

   • 保存 settings.json 文件。

Cursor 现在应该可以识别“OpenAI Image Gen”服务，其工具（text-to-image、image-to-image）将在 MCP 工具选择列表中提供（例如，在聊天中使用 @ 提及或通过代码操作）。

设置

1. 克隆仓库：

   git clone <your-repository-url>
   cd <repository-directory>
   

2. 安装依赖：

   npm install
   # or
   yarn install
   

3. 配置环境变量： 通过复制示例文件，在项目根目录中创建 .env 文件：

   cp .env.example .env
   

   编辑 .env 文件并添加你的 OpenAI API 密钥：

   OPENAI_API_KEY=your_openai_api_key_here
   

构建

将 TypeScript 代码构建为 JavaScript：

npm run build
# or
yarn build

这会将代码编译到 dist 目录中。

运行服务

本节介绍克隆并完成设置后如何在本地运行服务。如需在不克隆的情况下快速启动，请参阅使用 npx 快速运行部分。

使用 ts-node（用于开发）：

npx ts-node src/index.ts [options]

使用编译后的代码：

node dist/index.js [options]

选项：

• --models <model1> <model2> ...：指定服务应允许使用的 OpenAI 模型。如果未提供，默认允许使用 src/libs/openaiImageClient.ts 中定义的所有模型（当前为 gpt-image-1、dall-e-2、dall-e-3）。
  • 使用 npx 的示例（本地运行也适用）：... --models gpt-image-1 dall-e-3
  • 克隆后的示例：node dist/index.js --models dall-e-3 dall-e-2

服务将启动并通过标准输入/输出（使用 StdioServerTransport）侦听 MCP 请求。

MCP 工具

该服务提供以下 MCP 工具：

text-to-image

根据文本提示词生成图像。

参数：

• text（字符串，必填）：用于生成图像的提示词。
• model（枚举，可选）：要使用的模型（例如，gpt-image-1、dall-e-2、dall-e-3）。默认为第一个允许使用的模型。
• size（枚举，可选）：生成图像的尺寸（例如，1024x1024、1792x1024）。默认为 1024x1024。请查阅 OpenAI 文档，了解特定模型支持的尺寸。
• style（枚举，可选）：图像风格（vivid 或 natural）。仅适用于 dall-e-3。默认为 vivid。
• output_format（枚举，可选）：格式（png、jpeg、webp）。默认为 png。
• output_compression（数字，可选）：压缩级别（0-100）。默认为 100。
• moderation（枚举，可选）：内容审核级别（low、auto）。默认为 low。
• background（枚举，可选）：背景（transparent、opaque、auto）。默认为 auto。transparent 要求 output_format 为 png 或 webp。
• quality（枚举，可选）：质量（standard、hd、auto 等）。默认为 auto。hd 仅适用于 dall-e-3。
• n（数字，可选）：要生成的图像数量。默认为 1。注意：dall-e-3 仅支持 n=1。

返回值：

• content：包含以下内容的数组：
  • 一个 text 对象，其中包含已保存的临时图像文件路径（例如，/tmp/uuid.png）。

image-to-image

根据文本提示词和可选蒙版编辑现有图像。

参数：

• images（字符串，必填）：本地图像的文件路径数组。
• prompt（字符串，必填）：对所需编辑内容的文本描述。
• mask（字符串，可选）：蒙版图像（PNG）的文件路径。透明区域表示应编辑图像的位置。
• model（枚举，可选）：要使用的模型。编辑仅支持 gpt-image-1 和 dall-e-2。默认为第一个允许使用的模型。
• size（枚举，可选）：生成图像的尺寸（例如，1024x1024）。默认为 1024x1024。dall-e-2 仅支持 256x256、512x512、1024x1024。
• output_format（枚举，可选）：格式（png、jpeg、webp）。默认为 png。
• output_compression（数字，可选）：压缩级别（0-100）。默认为 100。
• quality（枚举，可选）：质量（standard、hd、auto 等）。默认为 auto。
• n（数字，可选）：要生成的图像数量。默认为 1。

返回值：

• content：包含以下内容的数组：
  • 一个 text 对象，其中包含已保存的临时图像文件路径（例如，/tmp/uuid.png）。

开发

• Lint 检查： npm run lint 或 yarn lint
• 格式化： npm run format 或 yarn format（如果在 package.json 中配置）

贡献

欢迎提交拉取请求（PR）！欢迎提交改进或错误修复。