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
  • inspect_animation — Check sprite sheet consistency across animation frames

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.9.2.tar.gz (89.8 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.9.2-py3-none-any.whl (54.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxel_mcp-0.9.2.tar.gz
  • Upload date:
  • Size: 89.8 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.9.2.tar.gz
Algorithm Hash digest
SHA256 b88f0661d4824fcc2b1fc9b5925c9e42dc47a6fc09230357f62c756145a5ff56
MD5 568655555b96458dcd0a6b88acc48ed1
BLAKE2b-256 046e5c3abff5609d4ef51f89522e68ab10cc3cf28687f5b5ff76f3168f3413f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxel_mcp-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 54.6 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.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9e43aa63636e4f0aa0f46094134844601b3fae82796985d66a1a73db3200bfe2
MD5 185e288b04d516d46489a2ea63d798da
BLAKE2b-256 363de7a6650e0b9c0957e381218f7a07c264b2a65186d8ce333a97b567b14eb1

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