DALL E

🚀 DALL-E MCP Server

The DALL-E MCP Server is a tool for generating, editing, and manipulating images, based on OpenAI's DALL-E AI model. It supports creating new images, editing existing images, and generating image variations.

🚀 Quick Start

The DALL-E MCP Server is a powerful tool that allows you to generate, edit, and manipulate images using OpenAI's DALL-E AI model. It provides a range of features to help you create and modify images according to your needs.

✨ Features

• Create New Images: Generate high-quality images using text descriptions.
• Edit Images: Modify existing images (currently limited to DALL-E 2).
• Generate Variations: Create multiple variations based on an existing image.
• Verify API Key: Confirm the validity of your OpenAI API access token.

📦 Installation

1. Clone this repository to your local machine.
2. Install the dependencies by running the following command:

   npm install
   

3. Configure the environment variables in the .env file as needed.

💻 Usage Examples

Installation Guide

Create a .env file in the root directory and add the following content (adjust according to your actual needs):

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

# Optional: Default location to save images
SAVE_DIR=/path/to/save/images

Operation Guide

Basic Usage

Create New Images

{
  "prompt": "A flying bluebird",
  "model": "dall-e-2",
  "size": "1024x1024",
  "n": 3,
  "saveDir": "/path/to/save/images",
  "fileName": "bluebird-fly"
}

Parameter Explanation:

• prompt: Required. A description of the image to be generated.
• model: Optional. Defaults to dall-e-2.
• size: Optional. Defaults to 1024x1024.
• n: Optional. Defaults to 1.

Edit Images

{
  "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/images",
  "fileName": "edited-image"
}

Parameter Explanation:

• prompt: Required. A description of the modifications needed.
• imagePath: Required. The path to the image to be edited.
• mask: Optional. Defaults to none.

Create Variations

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

Parameter Explanation:

• imagePath: Required. The path to the image for which variations will be generated.
• model: Optional. Defaults to dall-e-2.

Verify API Key

{}

No required parameters.

Advanced Usage

Development and Testing

Test Configuration

Important Note: The following .env configuration is only for testing purposes and is not required for normal operation.

Create a .env file in the root directory and add the following:

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

# Optional: Default save path
SAVE_DIR=/path/to/save/images

Test Execution

1. Start the server:

   npm start
   

2. Use postman or other tools to send a POST request to http://localhost:3000/api/process.

⚠️ Important Note

• Ensure that the paths in the .env file are correct to avoid permission issues.
• Use a valid API key for testing and be aware of the cost limits.