npm package: @mascoteer/mcp
Description: MCP server for Mascoteer - Create and animate mascots from Claude Desktop, Cursor, and other AI tools
Author: Mascoteer
Latest version: 0.1.0

# Mascot Animation MCP Server

Use Claude Desktop to create and animate mascots directly from your conversations!

## Installation

### Option 1: npm (recommended)

```bash
npm install -g @mascot-animation/mcp-server
```

### Option 2: From source

```bash
git clone https://github.com/your-repo/mascot-animation
cd mascot-animation/packages/mcp-server
npm install
npm run build
```

## Configuration

### 1. Get your API key

1. Go to [mascot-animation.app/developer/keys](https://mascot-animation.app/developer/keys)
2. Create a new API key
3. Copy the key (it's only shown once!)

### 2. Configure Claude Desktop

Add the following to your Claude Desktop config file:

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

```json
{
  "mcpServers": {
    "mascot-animation": {
      "command": "npx",
      "args": ["-y", "@mascot-animation/mcp-server"],
      "env": {
        "MASCOT_API_KEY": "ma_your_api_key_here"
      }
    }
  }
}
```

Or if installed from source:

```json
{
  "mcpServers": {
    "mascot-animation": {
      "command": "node",
      "args": ["/path/to/mascot-animation/packages/mcp-server/dist/index.js"],
      "env": {
        "MASCOT_API_KEY": "ma_your_api_key_here"
      }
    }
  }
}
```

### 3. Restart Claude Desktop

After updating the config, restart Claude Desktop to load the MCP server.

## Available Tools

### list_mascots
List all your mascots with pagination.

```
List my mascots
```

### get_mascot
Get details of a specific mascot.

```
Show me mascot abc-123
```

### create_mascot
Create a new mascot from a text description.

```
Create a mascot: a friendly purple dragon with tiny wings and big eyes
```

### delete_mascot
Delete a mascot and all its animations.

```
Delete mascot abc-123
```

### list_animations
List your animations, optionally filtered by mascot.

```
Show animations for mascot abc-123
```

### create_animation
Create a new animation (costs 1 credit).

```
Animate mascot abc-123: waving hello cheerfully
```

## Example Conversation

**You**: Create a mascot named "Pixel" that's a cute robot with antenna and LED eyes

**Claude**: I'll create that mascot for you...
[Uses create_mascot tool]
Mascot "Pixel" created! It's now being generated. I'll check the status...

**You**: Is it ready yet?

**Claude**: [Uses get_mascot tool]
Yes! Pixel is ready. Here's the T-pose sprite: [image URL]

**You**: Make it wave hello

**Claude**: [Uses create_animation tool]
Animation started! This will take a few minutes to generate.

## Environment Variables

| Variable | Description | Default |
|----------|-------------|---------|
| `MASCOT_API_KEY` | Your API key (required) | - |
| `MASCOT_API_URL` | API base URL | `https://mascot-animation.app/api/v1` |

## Requirements

- Node.js 18+
- Mascot Animation Pro or Business plan (for API access)
- Claude Desktop

## Troubleshooting

### "MASCOT_API_KEY environment variable is required"

Make sure you've added the API key to your Claude Desktop config.

### "API access requires Pro or Business plan"

Upgrade your plan at [mascot-animation.app/pricing](https://mascot-animation.app/pricing).

### Server not showing in Claude

1. Check the config file syntax (valid JSON)
2. Restart Claude Desktop
3. Check Claude Desktop logs for errors

## License

MIT