AOAI Dalle3 MCP Server

By jacwu GitHub

mcp-server dalle3

Overview

what is AOAI Dalle3 MCP Server?

AOAI Dalle3 MCP Server is an integration server that connects Azure OpenAI's DALL-E 3 image generation capabilities with clients that support the Model Context Protocol (MCP).

how to use AOAI Dalle3 MCP Server?

To use the server, set up the required environment variables for Azure OpenAI, install dependencies, build the server, and configure the MCP client to communicate with the server.

key features of AOAI Dalle3 MCP Server?

Generates images using DALL-E 3 based on text prompts.
Allows downloading of generated images to local storage.
Configurable image dimensions, quality, and style options.

use cases of AOAI Dalle3 MCP Server?

Creating unique images for creative projects based on textual descriptions.
Integrating image generation capabilities into applications that require visual content.
Automating the generation of images for marketing and advertising purposes.

FAQ from AOAI Dalle3 MCP Server?

What is required to run the AOAI Dalle3 MCP Server?

You need to set environment variables for Azure OpenAI, install dependencies, and build the server.

Can I customize the image generation parameters?

Yes! You can customize the image size, quality, and style when generating images.

Is there a limit to the number of images I can generate?

The limits depend on your Azure OpenAI subscription and usage policies.

Content

AOAI Dalle3 MCP Server

An Azure OpenAI DALL-E integration server implementing the Model Context Protocol (MCP). This server provides a bridge between Azure OpenAI's DALL-E 3 image generation capabilities and MCP-compatible clients.

Available Tools

`generate_image`

Generates images using DALL-E 3 with the following parameters:

prompt (required): Text description of the image to generate
- size (optional): Image dimensions (default: 1024x1024). Available options:
- 1024x1024
- 1792x1024
- 1024x1792
quality (optional): Image quality (default: hd). Available options:
- standard
- hd
style (optional): Image style (default: natural). Available options:
- vivid
- natural

`download_image`

Downloads generated images to local storage:

imageUrl (required): URL of the image to download
localPath (required): Local directory path for saving
fileName (required): Name for the downloaded file

Environment Variables

The following environment variables must be set to configure the server:

AZURE_OPENAI_ENDPOINT: The endpoint URL for your Azure OpenAI resource. You can find this in the Azure portal under your OpenAI resource's "Keys and Endpoint" section.
AZURE_OPENAI_API_KEY: The API key for your Azure OpenAI resource. This is also available in the "Keys and Endpoint" section.
AZURE_OPENAI_DEPLOYMENT_NAME (optional, default: "dalle3"): The name of the DALL-E 3 deployment in your Azure OpenAI resource.
OPENAI_API_VERSION (optional, default: "2024-02-15-preview"): The API version to use. Ensure this matches the version supported by your Azure OpenAI resource.

Build

Install dependencies:

npm install

Build the server:

npm run build

MCP Client Configuration

{
  "dalle3": {
                "command": "node",
                "args": [
                    "./build/index.js"
                ],
                "env": {
                    "AZURE_OPENAI_ENDPOINT": "<endpoint>",
                    "AZURE_OPENAI_API_KEY": "<key>",
                    "AZURE_OPENAI_DEPLOYMENT_NAME": "<deployment>"
                }
            }
}