Skip to main content
Glama
README.md
# AnimAgent MCP Server

<div align="center">

![AnimAgent Logo](https://app.sumatman.ai/assets/logos/animagent/animagent_ai.png)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org)
[![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-blue)](https://modelcontextprotocol.io)
[![Production Ready](https://img.shields.io/badge/Status-Production%20Ready-success)](https://app.sumatman.ai)

**🎬 Create Professional AI-Powered Story Animations Directly from Claude Desktop**

[English](README.md) | [δΈ­ζ–‡](README_CN.md)

</div>

---

## πŸš€ One-Click Installation

### macOS/Linux:
```bash
git clone https://github.com/preangelleo/animagent-mcp-server.git && cd animagent-mcp-server && ./install.sh
```

### Windows:
```cmd
git clone https://github.com/preangelleo/animagent-mcp-server.git && cd animagent-mcp-server && install.bat
```

**That's it!** The installer automatically:
- βœ… Checks Node.js installation
- βœ… Installs all dependencies
- βœ… Guides you through credential setup
- βœ… Configures Claude Desktop for you
- βœ… Verifies the connection

---

## 🌟 What is AnimAgent?

AnimAgent is the **world's first MCP server for AI-generated story animations**. Transform your ideas into professional animated videos through natural conversation with Claude Desktop - no video editing skills required!

### ✨ Key Features

- **🎭 13 Story Types**: Fairytales, Sci-Fi, Educational, Romance, Adventure, and more
- **🌍 12 Languages**: English, Chinese, Spanish, French, Hindi, Arabic, and more
- **🎨 18 Art Styles**: Ghibli, Pixar, Watercolor, Oil Painting, Comic, and more
- **⏱️ Flexible Duration**: 5 to 60 minutes
- **πŸ“± Multiple Formats**: Landscape (16:9), Portrait (9:16), Square (1:1)
- **πŸš€ Cloud-Based**: No GPU required, all processing in the cloud
- **πŸ’¬ Natural Language**: Just describe what you want in plain English


---

## 🎯 Quick Start Guide

### Step 1: Get Your Credentials (2 minutes)

1. **Register** at [app.sumatman.ai](https://app.sumatman.ai)
2. **Login** with your email
3. **Copy** your User ID from the Welcome page
4. **Remember** your email address

### Step 2: Install the Client (1 minute)

Run the one-click installer above, or manually:

```bash
# Clone and install
git clone https://github.com/preangelleo/animagent-mcp-server.git
cd animagent-mcp-server
npm install

# Configure credentials
cp .env.example .env
# Edit .env with your User ID and Email

# Setup Claude Desktop
npm run setup
```

### Step 3: Start Creating! (Instant)

In Claude Desktop, simply type:

```
"Create a 10-minute fairytale about a brave mouse discovering magical cheese"
```

---

## πŸ’¬ Usage Examples

### Basic Creation
```
"Create a children's story about friendship"
```

### With Full Customization
```
"Create a 15-minute sci-fi adventure in Japanese anime style, 
suitable for teenagers, with Chinese narration"
```

### With Advanced Options
```
"Create an educational story with subtitles and zoom effects enabled"
```

### Task Management
```
"Show me the status of my animation task"
"Edit task web_123_abc to change duration to 20 minutes"
"Repeat my last task but with a different story"
```

---

## πŸ› οΈ Available Commands

| Command | Description | Example |
|---------|-------------|---------|
| **create_animation_task** | Create new animation | "Create a story about..." |
| **get_task_details** | Check task status | "Show task web_123_abc" |
| **edit_animation_task** | Modify pending task | "Edit task to change..." |
| **repeat_animation_task** | Create variation | "Repeat task with new story" |
| **delete_animation_task** | Remove pending task | "Delete task web_123_abc" |

### 🎬 Advanced Video Options (v2.2.0)

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| **enable_subtitle** | Boolean | false | Add synchronized subtitles to your video |
| **enable_zoom_effect** | Boolean | false | Add cinematic zoom in/out effects for dynamic visuals |
| **watermark_enabled** | Boolean | false | Add custom watermark (requires upload at app.sumatman.ai) |

---

## 🎨 Customization Options

<details>
<summary><b>πŸ“š Story Types (13 options)</b></summary>

- `fairytale_story` - Magical fairytales
- `educational_story` - Learning content
- `historical_story` - Historical events
- `sci_fi_story` - Science fiction
- `fantasy_story` - Fantasy worlds
- `adventure_story` - Epic adventures
- `romantic_story` - Love stories
- `cinematic_story` - Movie-style
- `bible_story` - Biblical stories
- `poetry_story` - Poetic narratives
- `lyric_story` - Musical stories
- `comics_story` - Comic book style
- `book_story` - Book adaptations

</details>

<details>
<summary><b>🎨 Popular Art Styles</b></summary>

- **Animation Styles**: Ghibli, Pixar, Disney, Anime
- **Traditional Art**: Oil Painting, Watercolor, Chinese Ink
- **Modern Styles**: Digital Art, Vector Graphics, 3D Rendering
- **Unique Styles**: Steampunk, Cyberpunk, Fantasy Art

[View all 18 styles with samples β†’](https://animagent.ai/illustration-styles)

</details>

<details>
<summary><b>🌍 Supported Languages</b></summary>

English, Chinese, Spanish, French, Hindi, Arabic, Bengali, Portuguese, Russian, Japanese, German, Korean

</details>

---

## πŸ”§ Advanced Configuration

### Manual Claude Desktop Setup

If automatic setup doesn't work, manually edit Claude's config:

**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`  
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

```json
{
  "mcpServers": {
    "animagent": {
      "command": "node",
      "args": ["/path/to/animagent-mcp-server/src/index.js"],
      "env": {
        "ANIMAGENT_USER_ID": "your-user-id",
        "ANIMAGENT_USER_EMAIL": "your-email@example.com"
      }
    }
  }
}
```

### Environment Variables

| Variable | Description | Required |
|----------|-------------|----------|
| `ANIMAGENT_USER_ID` | Your user ID from app.sumatman.ai | βœ… Yes |
| `ANIMAGENT_USER_EMAIL` | Your registered email | βœ… Yes |
| `ANIMAGENT_MCP_SERVER_URL` | Server URL (default: https://app.sumatman.ai/api/mcp) | ❌ No |
| `DEBUG` | Enable debug logging | ❌ No |

---

## 🚨 Troubleshooting

### Common Issues & Solutions

<details>
<summary><b>❌ "Client Validation Error - TASK_ID IS MANDATORY"</b></summary>

**Solution**: Always provide the task ID when editing/repeating/deleting:
```
βœ… "Edit task web_123_abc to change duration"
❌ "Edit my task to change duration"
```

</details>

<details>
<summary><b>❌ "User credentials not configured"</b></summary>

**Solution**:
1. Check your `.env` file has correct credentials
2. Verify User ID matches the one from app.sumatman.ai
3. Restart Claude Desktop after changes

</details>

<details>
<summary><b>❌ "Connection refused" or timeout errors</b></summary>

**Solution**:
1. Check internet connection
2. Verify https://app.sumatman.ai is accessible
3. Try `npm run test` to test connection
4. Check firewall/proxy settings

</details>

---

## πŸ’° Pricing

- **Credit System**: 50 credits per minute of video
- **Free Trial**: 100 credits on signup
- **Packages**: From $1 (10 credits) to $500 (7,000 credits)
- **View Balance**: [app.sumatman.ai/credits](https://app.sumatman.ai/credits)

---

## πŸ—οΈ Technology Stack

### AI-Powered Components

- **πŸ“ Story Creation**: Google Gemini Pro 2.5 transforms your ideas into compelling narratives and structured storylines with image description for each scene
- **🎀 Voice Acting**: Volcano Engine for authentic Chinese voice generation, ElevenLabs for international voices and subtitle force alignment  
- **🎨 Visual Generation**: Advanced Flux Kontext Max and QWen models ensure consistent, beautiful scene generation with proper text rendering
- **🎬 Video Processing**: CloudBurst Fargate enables parallel video processing - fast rendering regardless of the number of scenes

## πŸ—οΈ Architecture

```mermaid
graph LR
    A[Claude Desktop] -->|MCP Protocol| B[AnimAgent Client]
    B -->|HTTPS/JSON-RPC| C[AnimAgent Server]
    C -->|Process| D[AI Pipeline]
    D --> E[Gemini Pro 2.5 Story]
    D --> F[Flux Kontext Max/QWen Images]
    D --> G[Volcano Engine/ElevenLabs Voice]
    D --> H[CloudBurst Fargate Video]
    H -->|Final Video| I[User Dashboard]
```

---

## 🀝 Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

```bash
# Fork and clone
git clone https://github.com/YOUR_USERNAME/animagent-mcp-server.git

# Create feature branch
git checkout -b feature/amazing-feature

# Commit changes
git commit -m 'Add amazing feature'

# Push and create PR
git push origin feature/amazing-feature
```

---

## πŸ“„ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

## πŸ†˜ Support

- **Website**: [app.sumatman.ai](https://app.sumatman.ai)
- **GitHub Issues**: [Report a bug](https://github.com/preangelleo/animagent-mcp-server/issues)
- **Email**: support@sumatman.ai

---

## πŸ™ Acknowledgments

- Built with [Model Context Protocol](https://modelcontextprotocol.io) by Anthropic
- Powered by [Sumatman AI](https://animagent.ai)
- Special thanks to all our early adopters and contributors

---

<div align="center">

**⭐ Star us on GitHub if you find this useful!**

[🌟 Star](https://github.com/preangelleo/animagent-mcp-server) · 
[πŸ› Report Bug](https://github.com/preangelleo/animagent-mcp-server/issues) Β· 
[πŸ’‘ Request Feature](https://github.com/preangelleo/animagent-mcp-server/issues)

Made with ❀️ by [Sumatman AI](https://animagent.ai)

</div>