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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyxel_mcp-0.6.0.tar.gz
  • Upload date:
  • Size: 49.4 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.6.0.tar.gz
Algorithm Hash digest
SHA256 fa580d83a717b9315fed83c6e925b811d2354bed132f177777d596928e1039d0
MD5 2219c7056ddb6ab380ee708d07ef7b9b
BLAKE2b-256 8bf135068de16f99e907d0999a1273a19b3d101f005d730a053c533fdc679f93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyxel_mcp-0.6.0-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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c0c7d6cdfcf3b24aa95fd34622fe93fb2b28db6a5c51bb9a137a2c558625ba6b
MD5 bca06b93fc373be7d51d56c7d1e1a4af
BLAKE2b-256 11eee8cb7714bae6e68e5728887a98106f13092daa2f64f8def39619789cf886

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