---
title: ImageAlfred
emoji: 😻
colorFrom: green
colorTo: purple
sdk: gradio
sdk_version: 5.32.1
app_file: src/app.py
pinned: false
license: apache-2.0
short_description: 'Alfred of Images: An MCP server to handle your image edits.'
---

![Image Alfred](./src/assets/ImageAlfredIcon.png)

# ImageAlfred

ImageAlfred is an image Model Context Protocol (MCP) tool designed to streamline image processing workflows.
<!-- It provides a user-friendly interface for interacting with image models, leveraging the power of Gradio for the frontend and Modal for scalable backend deployment. -->

<!-- ## Features
- Intuitive web interface for image processing
- Powered by Gradio for rapid prototyping and UI
- Scalable and serverless execution with Modal
- Easily extendable for custom image models and workflows -->

## Maintainers
[Mahan Yarmohammad (Mahan-ym)](https://www.mahan-ym.com/)
[Saaed Saadatipour (Soodoo)](https://soodoo.me/)

# Used Tools
- [Gradio](https://www.gradio.app/): Serving user interface and MCP server
- [lang-segment-anything](https://github.com/luca-medeiros/lang-segment-anything): Which uses [SAM](https://segment-anything.com/) and [Grounding Dino](https://github.com/IDEA-Research/GroundingDINO) under the hood to segment images.
- [HuggingFace](https://huggingface.co/): Downloading SAM and using Space for hosting.
- [Modal.com](https://modal.com/): AI infrastructure making all the magic possible.

## Getting Started

### Prerequisites
- Python 3.13+
- [uv](https://github.com/astral-sh/uv) (a fast Python package installer and virtual environment manager)

### Installation

1. **Create a virtual environment using uv:**

```bash
uv venv
```

2. **Activate the virtual environment:**

```bash
source .venv/bin/activate
```

3. **Install dependencies:**

```bash
uv sync
```

4. **Setup Modal**

```bash
modal setup
```

### Running the App

```bash
uv run src/app.py
```

This will launch the Gradio interface for ImageAlfred.

## License

This project is licensed under the terms of the LICENSE file in this repository.