# MascotVibe in Your IDE

Generate and animate mascots directly from Claude Desktop, Cursor, VS Code, or any AI tool that supports the [Model Context Protocol](https://modelcontextprotocol.io/). No browser required.

## What is MCP?

The Model Context Protocol (MCP) is an open standard that lets AI assistants connect to external tools and services. Instead of copy-pasting between your browser and your AI tool, MCP lets the AI call APIs directly on your behalf.

With the MascotVibe MCP server, you can ask Claude, Cursor, or Copilot to generate mascots, animate them, check your credit balance, and more. The AI handles the API calls while you stay focused on your work.

## Installation

No installation needed if you use `npx`. Just add the configuration to your AI tool and you're ready to go.

### Claude Desktop

Add to your `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "mascotvibe": {
      "command": "npx",
      "args": ["-y", "@mascotvibe/mcp-server"],
      "env": {
        "MASCOTVIBE_API_KEY": "your-api-key-here"
      }
    }
  }
}
```

### Cursor

Add to `.cursor/mcp.json` in your project root:

### VS Code / Copilot

Add to `.vscode/settings.json`:

```json
{
  "mcp": {
    "servers": {
      "mascotvibe": {
        "command": "npx",
        "args": ["-y", "@mascotvibe/mcp-server"],
        "env": {
          "MASCOTVIBE_API_KEY": "your-api-key-here"
        }
      }
    }
  }
}
```

## Available Tools

### `generate_mascot`
Generate AI mascot characters from a text description or website URL. Returns 4 unique variations in your chosen art style.

**Parameters**
- `description` (string): Describe your brand or desired mascot
- `websiteUrl` (string): Website URL for brand context
- `style` (enum): kawaii, cartoon, 3d-render, flat, pixel, hand-drawn (default: cartoon)

### `animate_mascot`
Animate a mascot with various animation styles. Creates WebM, APNG, and MP4 outputs.

**Parameters**
- `mascotId` (string, required): The mascot ID to animate
- `animationType` (enum, required): wave, celebrate, idle, think, sad, dance, sleep, angry, nod, jump, spin, peek, custom
- `duration` (number): 5 or 10 seconds (default: 5)
- `size` (number): 128, 256, 512, or 720 pixels (default: 512)
- `customPrompt` (string): Custom animation description (required for "custom" type)

### `check_animation`
Check the status of an animation job and get download URLs when complete.

**Parameters**
- `animationId` (string, required): The animation job ID

### `list_mascots`
List your MascotVibe mascots with IDs, names, and images.

**Parameters**
- `limit` (number): Max mascots to return, 1-100 (default: 20)

### `check_credits`
Check your MascotVibe credit balance.

No parameters required

## Example Conversations

### Generating a mascot
**You**: Create a mascot for my coffee shop called "Bean There" in kawaii style  
**AI**: I'll generate mascots for your coffee shop! Let me create 4 kawaii-style variations based on the "Bean There" brand...  
**AI**: Here are your 4 mascots! 1. Brewster (a cheerful coffee bean), 2. Latte (a cozy bear barista), 3. Mocha (a playful cat with a coffee cup), 4. Espresso (a zippy robot brewing coffee). Which one do you like best?

### Animating a mascot
**You**: Animate Brewster with a wave animation at 720px  
**AI**: Starting a wave animation for Brewster at 720px. I'll check back when it's ready...  
**AI**: Your animation is done! Here are the download links: WebM (Chrome/Android), APNG (iOS/Safari), MP4 (universal). The wave animation turned out great with Brewster's little coffee bean arms.

### Quick credit check
**You**: How many MascotVibe credits do I have left?  
**AI**: You have 42 credits remaining. That's enough for about 8 mascot generations or 2 five-second animations.

## Get Your API Key

Sign up for MascotVibe and create an API key to start generating mascots from your IDE.

[Get API Key](/content/dashboard/api-keys/index.html) [REST API Docs](/content/docs/api/index.html)
