Skip to main content

MCP server for Pyxel, a retro game engine for Python. Enables AI to autonomously run, verify, and iterate on retro game programs.

Project description

pyxel-mcp

MCP server for Pyxel, a retro game engine for Python. Enables AI to autonomously run, verify, and iterate on retro game programs.

Features

Run & Capture

  • run_and_capture — Run a Pyxel script and capture a screenshot after N frames
  • capture_frames — Capture screenshots at multiple frame points for animation verification
  • play_and_capture — Play a game by sending simulated input and capture screenshots

Inspect & Debug

  • validate_script — Validate a Pyxel script without running it
  • inspect_state — Read game object attributes at specific frames for debugging
  • inspect_screen — Capture screen as a compact color index grid
  • compare_frames — Compare screenshots at two frames and report pixel differences

Visual Analysis

  • inspect_sprite — Inspect sprite pixel data from a Pyxel image bank
  • inspect_layout — Analyze screen layout, text alignment, and visual balance
  • inspect_palette — Analyze color usage and contrast in a Pyxel screenshot
  • inspect_bank — Visualize an entire Pyxel image bank as a single screenshot
  • inspect_tilemap — Inspect tilemap content, tile usage, and layout

Audio

  • render_audio — Render a Pyxel sound or music to WAV and return waveform analysis

Utility

  • pyxel_info — Get Pyxel installation info: package location, examples path, and API stubs path

Getting Started

Just ask your AI agent (e.g. Claude Code) to create a Pyxel game. The agent will automatically discover and set up pyxel-mcp from the MCP Registry.

Manual Installation

  1. Install the package:
pip install pyxel-mcp
  1. Register pyxel-mcp as an MCP server in your AI agent. For Claude Code, add to your project's .mcp.json:
{
  "mcpServers": {
    "pyxel": {
      "type": "stdio",
      "command": "pyxel-mcp"
    }
  }
}

MCP Registry

mcp-name: io.github.kitao/pyxel-mcp

License

MIT

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

pyxel_mcp-0.8.1.tar.gz (49.2 kB view details)

Uploaded Source

Built Distribution

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

pyxel_mcp-0.8.1-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

Details for the file pyxel_mcp-0.8.1.tar.gz.

File metadata

  • Download URL: pyxel_mcp-0.8.1.tar.gz
  • Upload date:
  • Size: 49.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for pyxel_mcp-0.8.1.tar.gz
Algorithm Hash digest
SHA256 b8bb6f9e8671c5527b4fccde8edbe28dff616f45d4abf1f6c73d2c62cc041e4f
MD5 80f62dd9cc17f5d7d3ee7fa8574caa79
BLAKE2b-256 bad35deba0e346bd3a2378e5859dfcf8e8a9d385f29f2a6cd4c96e09b4494eb1

See more details on using hashes here.

File details

Details for the file pyxel_mcp-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: pyxel_mcp-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 46.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for pyxel_mcp-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cca728c4acdde45b9b68f600bf5b9a248c3cc92ca08eeb7f0047b990818c1fbc
MD5 a65db8ceca1bf8988672ed31c529ad0c
BLAKE2b-256 5896c58f6da57156f2b7df2ccc3dee98ea3f1c183260dc9ca0f46d21c39bb3a9

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