Skip to content

Commit

Permalink
πŸ“ Update README with engaging styling and refined description
Browse files Browse the repository at this point in the history
  • Loading branch information
splendasucks committed Dec 20, 2024
1 parent cf454c3 commit 5edc130
Showing 1 changed file with 41 additions and 17 deletions.
58 changes: 41 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,52 @@
# WebPerfect MCP Server
<div align="center">

An intelligent MCP server with a fully automated batch pipeline for web-ready images. Features include noise reduction, auto levels/curves, JPEG artifact removal, 4K resizing, smart sharpening with shadow/highlight enhancement, and advanced WebP conversion. Optimized compression delivers smaller files without sacrificing quality.
# 🎨 WebPerfect MCP Server

## Features
> Transform your images into web-optimized masterpieces with AI-powered precision
### Advanced Image Processing Pipeline
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D16-brightgreen)](https://nodejs.org)
[![Sharp](https://img.shields.io/badge/sharp-latest-blue)](https://sharp.pixelplumbing.com)

</div>

---

## ✨ Overview

WebPerfect is a cutting-edge MCP server that revolutionizes image optimization for the web. Using advanced AI algorithms and sophisticated processing techniques, it automatically enhances your images while dramatically reducing file sizes - all without compromising visual quality.

### πŸš€ Key Benefits

- **Intelligent Processing**: AI-powered algorithms adapt to each image's unique characteristics
- **Superior Quality**: Enhanced visual clarity with smart sharpening and noise reduction
- **Maximum Compression**: Achieve up to 80% size reduction while preserving image quality
- **Batch Automation**: Process entire directories with a single command
- **Web Optimized**: Perfect for modern web applications and responsive designs

## πŸ›  Features

### πŸ”„ Advanced Image Processing Pipeline
1. Strong noise reduction using median filtering
2. Intelligent auto levels and curves based on image entropy
3. Advanced texture enhancement with modulation and sharpening
4. Smart resolution optimization (up to 4K)
5. Optimized WebP conversion

### Tools
### πŸ”§ Tools

#### `process_images`
Process and optimize a batch of images with advanced enhancements.
#### πŸ“¦ `process_images`
Effortlessly process and optimize entire image collections with our advanced enhancement pipeline.
```typescript
{
inputDir: string; // Directory containing input images
outputDir: string; // Directory for optimized output
}
```

### Resources
### πŸ“Š Resources

#### Resource Templates
#### πŸ“ˆ Resource Templates
- `logs/{date}`: Access processing logs by date (YYYY-MM-DD)
```json
{
Expand Down Expand Up @@ -103,7 +125,9 @@ Process and optimize a batch of images with advanced enhancements.
}
```

## Installation
## πŸš€ Getting Started

### πŸ“₯ Installation

1. Clone the repository:
```bash
Expand All @@ -121,7 +145,7 @@ npm install
npm run build
```

## Usage with Claude
## πŸ€– Usage with Claude

1. Add the server to your Claude MCP settings (typically in `claude_desktop_config.json`):
```json
Expand Down Expand Up @@ -159,12 +183,12 @@ npm run build
</access_mcp_resource>
```

## Requirements
## πŸ“‹ Requirements

- Node.js >= 16
- Sharp image processing library
- Model Context Protocol SDK
- πŸ“¦ Node.js >= 16
- πŸ–ΌοΈ Sharp image processing library
- πŸ”Œ Model Context Protocol SDK

## License
## πŸ“„ License

MIT
[MIT](LICENSE) Β© 2024 WebPerfect Contributors

0 comments on commit 5edc130

Please sign in to comment.