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
  • capture_frames — Capture screenshots at multiple frame points for animation verification
  • play_and_capture — Simulate keyboard/mouse input and capture screenshots

Inspect & Debug

  • validate_script — Check syntax and common anti-patterns without running Pyxel
  • inspect_state — Read game object attributes at specific frames with timeline diff
  • inspect_screen — Capture screen as a compact color index grid (no image tokens)
  • compare_frames — Compare two frames and report pixel differences

Visual Analysis

  • inspect_sprite — Read sprite pixel data from image banks, report symmetry and colors
  • inspect_layout — Analyze screen layout, text positioning, and visual balance
  • inspect_palette — Analyze color usage, distribution, and contrast issues
  • inspect_bank — Visualize an entire 256x256 image bank as a screenshot
  • inspect_tilemap — Inspect tilemap content, tile usage, and layout

Audio

  • render_audio — Render a Pyxel sound or music to WAV and analyze notes, rhythm, and key

Utility

  • pyxel_info — Get Pyxel installation paths (API stubs, examples)

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.7.4.tar.gz (50.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.7.4-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxel_mcp-0.7.4.tar.gz
  • Upload date:
  • Size: 50.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.7.4.tar.gz
Algorithm Hash digest
SHA256 45ef670fbaaa813a629d2817e8f7f7e86f1181b89232317b7001292e07b0de4e
MD5 9be2dd74c5d87ef922841cceb2f4d976
BLAKE2b-256 0f757f2dda66b8d93dc471d95916e5abc7aff3232a44e31e87464619d4f2ed58

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxel_mcp-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 48.5 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.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 64c2ddce2c9646a26bfbf8821f37a089ebabedb8f69aee670416aec49dce6db1
MD5 07e02ca2c0c42aa3b61d29bce3073e7f
BLAKE2b-256 82a50118c461b56664734ce8eb14507d3e64b812bfafc1ce81befae0bc27b1b3

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