DALL-E MCP Server

DALL-E MCP 服务

一个使用 OpenAI 的 DALL-E API 生成图像的 MCP（Model Context Protocol）服务。

功能

• 使用 DALL-E 2 或 DALL-E 3 生成图像
• 编辑现有图像（仅 DALL-E 2）
• 创建现有图像的变体（仅 DALL-E 2）
• 验证 OpenAI API 密钥

安装

# Clone the repository
git clone https://github.com/Garoth/dalle-mcp.git
cd dalle-mcp

# Install dependencies
npm install

# Build the project
npm run build

Cline 用户须知

将此 DALL-E MCP 服务与 Cline 搭配使用时，建议将生成的图像保存到当前工作区目录，并将 saveDir 参数设置为与当前工作目录一致。这样可确保 Cline 能在对话中正确找到并显示生成的图像。

与 Cline 搭配使用的示例：

{
  "prompt": "A tropical beach at sunset",
  "saveDir": "/path/to/current/workspace"
}

使用方法

运行服务

# Run the server
node build/index.js

Cline 配置

在 VSCode 的设置中，将 dall-e 服务添加到 Cline MCP 设置文件中（例如 ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json）：

{
  "mcpServers": {
    "dalle-mcp": {
      "command": "node",
      "args": ["/path/to/dalle-mcp-server/build/index.js"],
      "env": {
        "OPENAI_API_KEY": "your-api-key-here",
        "SAVE_DIR": "/path/to/save/directory"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

请务必：

1. 将 /path/to/dalle-mcp-server/build/index.js 替换为构建后的 index.js 文件的实际路径
2. 将 your-api-key-here 替换为你的 OpenAI API 密钥

可用工具

generate_image

根据文本提示词使用 DALL-E 生成图像。

{
  "prompt": "A futuristic city with flying cars and neon lights",
  "model": "dall-e-3",
  "size": "1024x1024",
  "quality": "standard",
  "style": "vivid",
  "n": 1,
  "saveDir": "/path/to/save/directory",
  "fileName": "futuristic-city"
}

参数：

• prompt（必需）：所需图像的文本描述
• model（可选）：要使用的 DALL-E 模型（"dall-e-2" 或 "dall-e-3"，默认值："dall-e-3"）
• size（可选）：生成图像的尺寸（默认值："1024x1024"）
  • DALL-E 3："1024x1024"、"1792x1024" 或 "1024x1792"
  • DALL-E 2："256x256"、"512x512" 或 "1024x1024"
• quality（可选）：生成图像的质量，仅适用于 DALL-E 3（"standard" 或 "hd"，默认值："standard"）
• style（可选）：生成图像的风格，仅适用于 DALL-E 3（"vivid" 或 "natural"，默认值："vivid"）
• n（可选）：要生成的图像数量（1-10，默认值：1）
• saveDir（可选）：保存生成图像的目录（默认值：当前目录或 .env 中的 SAVE_DIR）。Cline 用户： 建议将此项设为当前工作区目录，以便正确显示图像。
• fileName（可选）：生成图像的基础文件名（不含扩展名，默认值："dalle-{timestamp}"）

edit_image

根据文本提示词使用 DALL-E 编辑现有图像。

⚠️ 已知问题（2025 年 3 月 18 日）： DALL-E 2 图像编辑 API 目前存在一个错误，有时会忽略提示词并返回未作任何编辑的原始图像，即使使用格式正确的 RGBA 图像和蒙版也是如此。此问题已在 OpenAI 社区论坛 中报告。如果遇到此问题，请尝试改用 create_variation 工具，该工具似乎更可靠。

{
  "prompt": "Add a red hat",
  "imagePath": "/path/to/image.png",
  "mask": "/path/to/mask.png",
  "model": "dall-e-2",
  "size": "1024x1024",
  "n": 1,
  "saveDir": "/path/to/save/directory",
  "fileName": "edited-image"
}

参数：

• prompt（必需）：所需编辑内容的文本描述
• imagePath（必需）：待编辑图像的路径
• mask（可选）：蒙版图像的路径（白色区域将被编辑，黑色区域将保留）
• model（可选）：要使用的 DALL-E 模型（目前只有 "dall-e-2" 支持编辑，默认值："dall-e-2"）
• size（可选）：生成图像的尺寸（默认值："1024x1024"）
• n（可选）：要生成的图像数量（1-10，默认值：1）
• saveDir（可选）：保存已编辑图像的目录（默认值：当前目录或 .env 中的 SAVE_DIR）。Cline 用户： 建议将此项设为当前工作区目录，以便正确显示图像。
• fileName（可选）：已编辑图像的基础文件名（不含扩展名，默认值："dalle-edit-{timestamp}"）

create_variation

使用 DALL-E 创建现有图像的变体。

{
  "imagePath": "/path/to/image.png",
  "model": "dall-e-2",
  "size": "1024x1024",
  "n": 4,
  "saveDir": "/path/to/save/directory",
  "fileName": "image-variation"
}

参数：

• imagePath（必填）：要创建变体的图像路径
• model（可选）：要使用的 DALL-E 模型（目前只有 "dall-e-2" 支持创建变体，默认值："dall-e-2"）
• size（可选）：生成图像的尺寸（默认值："1024x1024"）
• n（可选）：要生成的变体数量（1-10，默认值：1）
• saveDir（可选）：保存变体图像的目录（默认值：当前目录或 .env 中的 SAVE_DIR）。**对于 Cline 用户：**建议将其设置为当前工作区目录，以便正确显示图像。
• fileName（可选）：变体图像的基础文件名（不含扩展名，默认值："dalle-variation-{timestamp}"）

validate_key

验证 OpenAI API 密钥。

{}

无需参数。

开发

测试配置

注意：以下 .env 配置仅用于运行测试，正常使用时不需要。

如果你正在开发此项目或运行测试，请在根目录下创建一个 .env 文件，并填入你的 OpenAI API 密钥：

# Required for TESTS ONLY: OpenAI API Key
OPENAI_API_KEY=your-api-key-here

# Optional: Default save directory for test images
# If not specified, images will be saved to the current directory
# SAVE_DIR=/path/to/save/directory

正常使用 Cline 时，请按照上文“添加到 MCP 设置”部分的说明，在 MCP 设置 JSON 中配置 API 密钥。

你可以从 OpenAI API 密钥页面获取 API 密钥。

运行测试

# Run basic tests
npm test

# Run all tests including edit and variation tests
npm run test:all

# Run tests in watch mode
npm run test:watch

# Run specific test by name
npm run test:name "should validate API key"

注意：测试会调用真实 API，可能会产生 OpenAI 账户费用。

生成测试图像

此项目包含一个用于开发和测试的脚本，可生成测试图像：

# Generate a test image in the assets directory
npm run generate-test-image

此脚本会在 assets 目录中创建一个简单的测试图像，可用于测试编辑和变体功能。

许可证

MIT