Libresprite MCP

🚀 LibreSprite-MCP

Prompt your way into LibreSprite

This is a Model Context Protocol (MCP) server designed for prompt - assisted editing, designing, and scripting within LibreSprite.

https://github.com/user-attachments/assets/71440bba-16a5-4ee2-af10-2c346978a290

🚀 Quick Start

Prerequisites

The recommended approach to install and utilize this server is through uv. Below are quick one - liners for installation if you haven't installed it yet:

• Windows: (run as administrator)

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

• Unix:

curl -LsSf https://astral.sh/uv/install.sh | sh

For more details on installing uv.

The package is published on PyPI, so you can install it using your preferred method (e.g., pipx).

Usage

Step 1: Setting up the client

Add the MCP server to your MCP client using the following entry - point command (or an alternative command if you're not using uv):

uvx libresprite-mcp

Examples:

• Claude Desktop & Cursor Edit Claude > Settings > Developer > Edit Config > claude_desktop_config.json or .cursor > mcp.json to include the server:

{
    "mcpServers": {
        // ...existing servers...
        "libresprite": {
            "type": "stdio",
            "command": "uvx",
            "args": [
                "libresprite-mcp"
            ]
        }
        // ...existing servers...
    }
}

You can also use this convenient badge for quick installation:

⚠️ Important Note

You need to restart Claude Desktop to load the MCP Server.

Step 2: Setting up LibreSprite

Download the latest stable remote script mcp.js from releases and add it to LibreSprite's scripts folder:

Step 3: Connect and use

Run the mcp.js script (visible in the screenshot above), and ensure that your MCP server is running (Claude Desktop/Cursor is loaded and operational). If everything goes smoothly, you should see the following screen:

Click the "Connect" button, and you can now start discussing your next pixel - art project with Claude!

⚠️ Some pointers

• You can only run one instance of the MCP server at a time.
• The server requires port 64823 to be available.
• The server has a hacky and brittle implementation (refer to ARCHITECTURE) and has not been extensively tested.
• The MCP resources are of relatively low quality, with unclear API references and limited examples, which may sometimes confuse the LLM. If you're a LibreSprite expert, your help is needed.