Dalle MCP

🚀 DALL-E MCP Server

DALL-E MCP Server is a tool for generating, editing, and manipulating images, based on OpenAI's DALL-E model. It supports the following features:

1. Image Generation: Generate high-quality images based on text descriptions.
2. Image Editing: Edit specific areas of existing images.
3. Image Variation: Generate variant images with the same style as the original but different content.
4. Key Verification: Verify the validity of OpenAI API keys.

🚀 Quick Start

📦 Installation

Clone the Repository

Use Git to clone this repository:

git clone your-repository-url
cd dall-e-mcp-server

Install Dependencies

Run the following command to install the project's required dependencies:

npm install

Build the Project

Build the project to generate production files:

npm run build

⚠️ Important Note for Cline Users

When integrating this server into Cline, please ensure you configure the OpenAI API key as follows:

1. In Cline's MCP settings JSON file, add the openai_api_key field and set it to your own key.
2. Ensure the server has read and write permissions to correctly handle image files.

✨ Features

💻 Usage Examples

Basic Usage

The server provides several functions for image processing. Here are some basic usage examples:

Image Generation

Generate an image based on a text description:

{
  "prompt": "A flying owl",
  "model": "dall-e-3",
  "width": 512,
  "height": 512,
  "save_dir": "/path/to/save/images"
}

Image Editing

Edit a specific area of an existing image:

{
  "prompt": "Add a red heart in the middle of the picture",
  "image_path": "/path/to/image.jpg",
  "mask_path": "/path/to/mask.png",
  "model": "dall-e-2"
}

Image Variation

Generate variant images with the same style as the original:

{
  "image_path": "/path/to/image.jpg",
  "num_variations": 4,
  "size": "1024x1024"
}

Key Verification

Verify the validity of an OpenAI API key:

{}

🔧 Technical Details

Testing Configuration

Note: The following .env configuration is only for the test environment, not the production environment.

Create a .env file in the project's root directory and add the following content:

OPENAI_API_KEY=your-api-key-here
SAVE_DIR=/path/to/save/images

Running Tests

Run basic tests:

npm test

Run all tests (including editing and variation tests):

npm run test:all

Run tests in watch mode:

npm run test:watch

Run specific tests by name:

npm run test:name "should validate API key"

Generate Test Images

The project provides a script to generate test images for development and testing:

npm run generate-test-image

📄 License

This project is licensed under the MIT License.