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.2.tar.gz (49.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.7.2-py3-none-any.whl (48.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxel_mcp-0.7.2.tar.gz
  • Upload date:
  • Size: 49.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.7.2.tar.gz
Algorithm Hash digest
SHA256 1809748100e84b8c44a85150ef27c61985588ed81184e37cb255c7a1d632e1fc
MD5 e2bbb567b70f7dd0ed479ad5b3c04402
BLAKE2b-256 d9348e3b51524a1a3c94b7579a81a95ab5a4bd2885772186cf4eb09133982c84

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxel_mcp-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 48.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8e3791d059391893491f330cd34cb4364cea7f378a90d26ec7751ec0fb66e138
MD5 e7cbbc910b0b2758f6cf1ae144b8bc45
BLAKE2b-256 5393e0c74b12cfc008446f993323f3162936ad21f6d3e924dcba40c5276feedf

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