Skip to main content

Prompt your way into LibreSprite

Project description

LibreSprite-MCP

Install MCP Server PyPI version

Prompt your way into LibreSprite

Model Context Protocol (MCP) server for prompt-assisted editing, designing, and scripting inside LibreSprite.

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

Prerequisites

uv is the recommended way to install and use this server. Here are quick one-liners to install it if you haven't:

  • 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
    

More on installing uv.

The package is published on PyPI, so feel free to consume it any other way you prefer (pipx, etc)

Usage

Step 1: Setting up the client

Add the MCP server with the following entrypoint command (or something else if you are not using uv) to your MCP client:

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 fancy badge to make it quick:

    Install MCP Server

[!NOTE] You will have 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:

scripts-folder

Step 3: Connect and use

Run the mcp.js script (that you see in the screenshot above), and make sure your MCP server is running (Claude Desktop/Cursor is loaded and running). If all went well, you should see the following screen:

connect-button

Click the "Connect" button and you can now start talking to Claude about your next big pixel-art project!

Some pointers

  • You can only run one instance of the MCP server at a time.
  • The server expects port 64823 to be free.
  • The server has a hacky and brittle implementation (see ARCHITECTURE), and is not extensively tested.
  • The MCP resources are kinda low quality with unclear API reference and limited examples, leaving the LLM confused at times. If you're a LibreSprite expert, we need your help.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

libresprite_mcp-0.1.2.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

libresprite_mcp-0.1.2-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file libresprite_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: libresprite_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.4

File hashes

Hashes for libresprite_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6704b3648d89241ae4a02a010442f818a8a8db3c36cb09dd5e3740047b92a273
MD5 36bcf350c9f5196bcfa863cc9e986731
BLAKE2b-256 8f3b289136f00bb1b6d3ee62ed0b2b7a4c94a9056eca3cf977b97fc40c2701d7

See more details on using hashes here.

File details

Details for the file libresprite_mcp-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for libresprite_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9bf902d894e3f65cf9c64daaa8a736f644a3da3f10e50cf7799d04fe5bce0650
MD5 9da7f3c160e8842a3ae0e3c3259013cf
BLAKE2b-256 32837579f8c993005ae40a49c2917add24d7fa14d1dbc11e54b2ef57dba0fe42

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page