File size: 2,629 Bytes
558a267
 
 
4255d22
 
558a267
 
 
e0d0ee2
339972c
558a267
 
 
 
748425c
4c5de8f
8b98658
4c5de8f
748425c
8b98658
 
 
4255d22
4c5de8f
 
 
 
 
 
 
 
 
 
748425c
47fd4b6
 
 
748425c
 
4c5de8f
4255d22
4c5de8f
 
748425c
4255d22
4c5de8f
8b98658
4255d22
8b98658
 
 
ac24bf9
 
748425c
 
 
4c5de8f
 
748425c
 
 
 
4c5de8f
748425c
 
4c5de8f
748425c
 
 
 
4c5de8f
 
748425c
4c5de8f
748425c
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
---
title: ImageAlfred
emoji: 😻
tags:
  - mcp-server-track
colorFrom: green
colorTo: purple
sdk: gradio
sdk_version: 5.33.0
app_file: src/app.py
pinned: false
license: apache-2.0
short_description: 'Alfred of Images: An MCP server to handle your image edits.'
---

<div align="center">
<a href="https://github.com/mahan-ym/ImageAlfred">
<img src="./src/assets/icons/ImageAlfredIcon.png" alt="ImageAlfred" width=200 height=200>

<span><img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white"></span>

</a>
<h1>Image Alfred</h1>

ImageAlfred is an image Model Context Protocol (MCP) tool designed to streamline image processing workflows

<img alt="Python Version from PEP 621 TOML" src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmahan-ym%2FImageAlfred%2Fmain%2Fpyproject.toml">
<img src="https://badge.mcpx.dev?type=server" title="MCP Server"/>
<img alt="GitHub License" src="https://img.shields.io/github/license/mahan-ym/ImageAlfred">

<a href=https://huggingface.co> <img src="src/assets/icons/hf-logo.svg" alt="huggingface" height=40> </a>
<a href="https://www.python.org"><img src="src/assets/icons/python-logo-only.svg" alt="python" height=40></a>
</div>

## Demo

[🎬 Video demo](https://youtu.be/tEov-Bcuulk)

## Maintainers

[Mahan-ym | Mahan Yarmohammad](https://www.mahan-ym.com/)

[Soodoo | Saaed Saadatipour](https://soodoo.me/)

## Tools

- [Gradio](https://www.gradio.app/): Serving user interface and MCP server.
- [Modal.com](https://modal.com/): AI infrastructure making all the magic 🔮 possible.
- [SAM](https://segment-anything.com/): Segment Anything model by meta for image segmentation and mask generation.
- [CLIPSeg](https://github.com/timojl/clipseg): Image Segmentation using CLIP. We used it as a more precise object detection model.
- [OWLv2](https://huggingface.co/google/owlv2-large-patch14-ensemble): Zero-Shot object detection (Better performance in license plate detection and privacy preserving use-cases)
- [HuggingFace](https://huggingface.co/): Downloading SAM and using Space for hosting.

## Getting Started

### Prerequisites

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

### Installation

It will create virtual environment, activate it, install dependecies and setup modal

```bash
make install
```

### Running the App

This will launch the Gradio interface for ImageAlfred.

```bash
make run
```

## License

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