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.3.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.3-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: libresprite_mcp-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 99304742db123c384407049506c6c25642a887dac3b46885ca63b9a0b7079418
MD5 425e92c74ed6f3038b9b900343ad722c
BLAKE2b-256 3d5bc922630d887c097aeaac58b93d1f49dc7163357f90f37bcb4e44d225e271

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for libresprite_mcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 701ecf13585e02a9fc62e191f657441e4865075eb8a844884222cb34db58c0e9
MD5 ee43ad563e0b5553e41c72f86e1db2de
BLAKE2b-256 7a7190c255be9b3f39c6ca228ce75f7ebd615e47f8b533199197d1ae3597d67b

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