Image Creator MCP

🚀 Image Generation

This project is an image generation server that allows users to create and edit images via API. It offers detailed information and usage instructions.

🚀 Quick Start

📦 Install Dependencies

Run the following command to install the required dependencies:

npm install

▶️ Start the Service

You can start the development server with the following command:

npm run dev

Or build the production version and then start it:

npm run build && npm start

⚙️ Configuration

The project's configuration file is located at config.json. Here is the default configuration:

{
  "port": 5050,
  "openai_key": "your_openai_api_key",
  "storage_path": "./storage"
}

📋 Parameter Explanation

• port: The port on which the service listens, defaulting to 5050.
• openai_key: The OpenAI API key used for image generation.
• storage_path: The storage path for images.

📚 HTTP API Documentation

✨ Create a New Image

POST http://localhost:5050/api/create-image
Content-Type: application/json

{
  "prompt": "Describe the content of the image",
  "filename": "Image file name",
  "width": 800,
  "height": 600,
  "background": "#ffffff"
}

🖌️ Edit an Existing Image

POST http://localhost:5050/api/edit-image
Content-Type: application/json

{
  "prompt": "Edit description",
  "filename": "existing-image.png",
  "width": 1024,
  "height": 768,
  "background": "transparent"
}

🗑️ Delete an Image

DELETE http://localhost:5050/api/delete-image
Content-Type: application/json

{
  "filename": "Name of the image to be deleted"
}

🐳 Docker Support

🏗️ Build the Image

docker build -t image-generator .

🚢 Run the Container

docker run -d --name image-server -e OPENAI_API_KEY="your_api_key" image-generator:latest

💻 Development

▶️ Run the Development Server

npm run dev

🧪 Execute Tests

npm test

📄 License

MIT License