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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxel_mcp-0.8.2.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.2.tar.gz
Algorithm Hash digest
SHA256 2c9f9915edf46eb334cb338cd4fb22109ee6f653767bac181aa126e01bbb3f00
MD5 a223a32c6566a4a27a3599d0416c4e98
BLAKE2b-256 e2fcebfb8516b451218605fcaef47549f1d27a5bca143c267ce16712cf8fd484

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxel_mcp-0.8.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1c912020e08ec07b70013e780695c9f39d1b9c9b4a6d364aa2f759929fe0010a
MD5 caabcffc57cee8ab29d90a17865c5c17
BLAKE2b-256 cf08fad2b0d367bfdf7fdcd963631df760b28c0ccac2d0d33b56c2d6b551d387

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