Skip to main content
Glama

pixoo_push_image

pixoo_push_image
Idempotent

Resize an image or animated GIF to fit a Pixoo LED grid, optionally reduce it to a palette, and push it to the display while returning a preview of the exact frames shown.

Instructions

Load an image (absolute local path or https URL), resize it to fit the LED grid, and optionally push it to the display. An animated GIF or WebP pushes as an animation of up to maxFrames frames (default 40), sampled evenly from a longer source and played at the speed that keeps its loop length; past 40 frames it plays as one GIF the device downloads from this host. Returns the downsampled result as an image content block so you see exactly what the display received — for an animation, a grid of its frames, evenly sampled once they outnumber what fits the sheet. Nearest-neighbor kernel preserves pixel art; use lanczos3 or mitchell for photos. finish reduces the result to a small or fixed palette, optionally dithered.

Input Schema

NameRequiredDescriptionDefault
fitNoResize fit mode: contain (letterbox), cover (crop to fill), fill (stretch).contain
pushNoPush the resized image to the device (default: true).
speedNoMilliseconds per frame for an animated source (10–2000). Default: the source's total duration over the pushed frame count, or 150 when it records no delays. A still ignores it.
finishNoReduce the image to a palette before it reaches the panel: exactly one of colors (2–256, built from the image) or palette (1–256 hex or named colors), plus dither. Transparent pixels stay unlit and are not counted. The preview shows the finished frame.
kernelNoResize kernel: nearest for pixel art, lanczos3 for photos, mitchell for a balance.nearest
sourceYesAbsolute local file path or https (not http) URL of the image to display; a relative path is rejected. An animated GIF or WebP, whatever its file name, pushes as an animation.
maxFramesNoMost frames an animated source pushes (1–800, default 40); a longer source is sampled evenly down to it. Up to 40 push frame by frame; more play as one GIF the device downloads from this host, so the device must reach it (behind NAT or a firewall, set PIXOO_SERVE_HOST and PIXOO_SERVE_PORT), and speed rounds to the nearest 10 ms. A still ignores it.

Output Schema

NameRequiredDescriptionDefault
errorNoPresent when the call failed. Absent on success.
speedNoMilliseconds per frame the animation plays at. Absent for a still.
framesNoFrames rendered and pushed: 1 for a still, 2 to maxFrames for an animation.
noticeNoWarning or informational message.
pushedNoTrue when the device acknowledged the push; past 40 frames, once it accepted the GIF play, requested the file, and the whole file was handed to the OS to send (the device does not confirm receipt).
deviceStateNoDevice state after the push. Absent when push: false.
outputFilesNoAbsolute paths to saved preview files: a PNG for a still, an 8× GIF at the pushed speed for an animation, or past 40 frames the panel-size GIF the device downloads. Present only when PIXOO_OUTPUT_DIR is configured.
sourceFramesNoFrames in the source before sampling down to maxFrames: 1 for a still.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.4.1
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable. `device_http_error`: The device answered with a non-2xx HTTP status (retryable for 408, 429, 500, and 502–504). `device_rejected`: Device firmware returned a non-zero error code. `gif_serve_failed`: An animation of more than 40 frames could not be served to the device: its listener failed to open, its URL ran past 255 bytes, or the device did not request the GIF within 10 s of the play, stalled its transfer for 10 s, or dropped it. `no_device_configured`: PIXOO_IP is not set. `asset_not_found`: Image path or URL could not be read. `invalid_image`: The source was read but did not decode as an image. `invalid_color`: A finish palette entry could not be resolved to a color. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable over the network. `device_http_error`: The device answered with a non-2xx HTTP status (retryable for 408, 429, 500, and 502–504). `device_rejected`: Device firmware returned a non-zero error code. `gif_serve_failed`: An animation of more than 40 frames could not be served to the device: its listener failed to open, its URL ran past 255 bytes, or the device did not request the GIF within 10 s of the play, stalled its transfer for 10 s, or dropped it. `no_device_configured`: PIXOO_IP is not set and push was requested. `asset_not_found`: Image path or URL could not be read. `invalid_image`: The source was read but did not decode as an image. `invalid_color`: A finish palette entry could not be resolved to a color. Other values are possible when a failure originates below the handler."
  2. Changed7 schema fields changedv1.4.0
    • addedInput schema / properties / maxFrames
      Added value: +{
      +  "default": 40,
      +  "description": "Most frames an animated source pushes (1–800, default 40); a longer source is sampled evenly down to it. Up to 40 push frame by frame; more play as one GIF the device downloads from this host, so the device must reach it (behind NAT or a firewall, set PIXOO_SERVE_HOST and PIXOO_SERVE_PORT), and speed rounds to the nearest 10 ms. A still ignores it.",
      +  "maximum": 800,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable. `device_http_error`: The device answered with a non-2xx HTTP status (retryable for 408, 429, 500, and 502–504). `device_rejected`: Device firmware returned a non-zero error code. `no_device_configured`: PIXOO_IP is not set. `asset_not_found`: Image path or URL could not be read. `invalid_image`: The source was read but did not decode as an image. `invalid_color`: A finish palette entry could not be resolved to a color. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable. `device_http_error`: The device answered with a non-2xx HTTP status (retryable for 408, 429, 500, and 502–504). `device_rejected`: Device firmware returned a non-zero error code. `gif_serve_failed`: An animation of more than 40 frames could not be served to the device: its listener failed to open, its URL ran past 255 bytes, or the device did not request the GIF within 10 s of the play, stalled its transfer for 10 s, or dropped it. `no_device_configured`: PIXOO_IP is not set. `asset_not_found`: Image path or URL could not be read. `invalid_image`: The source was read but did not decode as an image. `invalid_color`: A finish palette entry could not be resolved to a color. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / error / properties / data / properties / reason / examples
      Previous value: -[
      -  "device_unreachable",
      -  "device_http_error",
      -  "device_rejected",
      -  "no_device_configured",
      -  "asset_not_found",
      -  "invalid_image",
      -  "invalid_color"
      -]New value: +[
      +  "device_unreachable",
      +  "device_http_error",
      +  "device_rejected",
      +  "gif_serve_failed",
      +  "no_device_configured",
      +  "asset_not_found",
      +  "invalid_image",
      +  "invalid_color"
      +]
    • changedOutput schema / properties / frames / description
      Previous value: -"Frames rendered and pushed: 1 for a still, 2–40 for an animation."New value: +"Frames rendered and pushed: 1 for a still, 2 to maxFrames for an animation."
    • changedOutput schema / properties / outputFiles / description
      Previous value: -"Absolute paths to saved preview files: a PNG for a still, a GIF at the pushed speed for an animation. Present only when PIXOO_OUTPUT_DIR is configured."New value: +"Absolute paths to saved preview files: a PNG for a still, an 8× GIF at the pushed speed for an animation, or past 40 frames the panel-size GIF the device downloads. Present only when PIXOO_OUTPUT_DIR is configured."
    • changedOutput schema / properties / pushed / description
      Previous value: -"True when the device acknowledged the push."New value: +"True when the device acknowledged the push; past 40 frames, once it accepted the GIF play, requested the file, and the whole file was handed to the OS to send (the device does not confirm receipt)."
    • changedOutput schema / properties / sourceFrames / description
      Previous value: -"Frames in the source before sampling down to 40: 1 for a still."New value: +"Frames in the source before sampling down to maxFrames: 1 for a still."
  3. Changed10 schema fields changedv1.3.0
    • addedInput schema / properties / finish
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "description": "Reduce to a palette built from the image.",
      +      "properties": {
      +        "colors": {
      +          "description": "Build a palette of at most this many colors (2–256) from the image itself.",
      +          "maximum": 256,
      +          "minimum": 2,
      +          "type": "integer"
      +        },
      +        "dither": {
      +          "default": "none",
      +          "description": "How palette colors are placed: none maps each pixel to its nearest color; bayer4 mixes the two nearest in an ordered 4×4 pattern; floyd-steinberg diffuses the difference to neighboring pixels, smoothest on photos.",
      +          "enum": [
      +            "none",
      +            "bayer4",
      +            "floyd-steinberg"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "colors"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "additionalProperties": false,
      +      "description": "Reduce to a fixed palette.",
      +      "properties": {
      +        "dither": {
      +          "default": "none",
      +          "description": "How palette colors are placed: none maps each pixel to its nearest color; bayer4 mixes the two nearest in an ordered 4×4 pattern; floyd-steinberg diffuses the difference to neighboring pixels, smoothest on photos.",
      +          "enum": [
      +            "none",
      +            "bayer4",
      +            "floyd-steinberg"
      +          ],
      +          "type": "string"
      +        },
      +        "palette": {
      +          "description": "Map every pixel to these colors (1–256 entries).",
      +          "items": {
      +            "description": "Hex color (#RRGGBB or #RGB) or a named color.",
      +            "type": "string"
      +          },
      +          "maxItems": 256,
      +          "minItems": 1,
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "palette"
      +      ],
      +      "type": "object"
      +    }
      +  ],
      +  "description": "Reduce the image to a palette before it reaches the panel: exactly one of colors (2–256, built from the image) or palette (1–256 hex or named colors), plus dither. Transparent pixels stay unlit and are not counted. The preview shows the finished frame."
      +}
    • changedInput schema / properties / source / description
      Previous value: -"Absolute local file path or https (not http) URL of the image to display."New value: +"Absolute local file path or https (not http) URL of the image to display; a relative path is rejected. An animated GIF or WebP, whatever its file name, pushes as an animation."
    • addedInput schema / properties / speed
      Added value: +{
      +  "description": "Milliseconds per frame for an animated source (10–2000). Default: the source's total duration over the pushed frame count, or 150 when it records no delays. A still ignores it.",
      +  "maximum": 2000,
      +  "minimum": 10,
      +  "type": "integer"
      +}
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "not": {
      -      "required": [
      -        "error"
      -      ]
      -    },
      -    "required": [
      -      "pushed"
      -    ]
      -  },
      -  {
      -    "required": [
      -      "error"
      -    ]
      -  }
      -]New value: +[
      +  {
      +    "not": {
      +      "required": [
      +        "error"
      +      ]
      +    },
      +    "required": [
      +      "pushed",
      +      "frames",
      +      "sourceFrames"
      +    ]
      +  },
      +  {
      +    "required": [
      +      "error"
      +    ]
      +  }
      +]
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable. `device_http_error`: The device answered with a non-2xx HTTP status (retryable for 408, 429, 500, and 502–504). `device_rejected`: Device firmware returned a non-zero error code. `no_device_configured`: PIXOO_IP is not set. `asset_not_found`: Image path or URL could not be read. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable. `device_http_error`: The device answered with a non-2xx HTTP status (retryable for 408, 429, 500, and 502–504). `device_rejected`: Device firmware returned a non-zero error code. `no_device_configured`: PIXOO_IP is not set. `asset_not_found`: Image path or URL could not be read. `invalid_image`: The source was read but did not decode as an image. `invalid_color`: A finish palette entry could not be resolved to a color. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / error / properties / data / properties / reason / examples
      Previous value: -[
      -  "device_unreachable",
      -  "device_http_error",
      -  "device_rejected",
      -  "no_device_configured",
      -  "asset_not_found"
      -]New value: +[
      +  "device_unreachable",
      +  "device_http_error",
      +  "device_rejected",
      +  "no_device_configured",
      +  "asset_not_found",
      +  "invalid_image",
      +  "invalid_color"
      +]
    • addedOutput schema / properties / frames
      Added value: +{
      +  "description": "Frames rendered and pushed: 1 for a still, 2–40 for an animation.",
      +  "type": "number"
      +}
    • changedOutput schema / properties / outputFiles / description
      Previous value: -"Absolute paths to saved PNG preview files. Present only when PIXOO_OUTPUT_DIR is configured."New value: +"Absolute paths to saved preview files: a PNG for a still, a GIF at the pushed speed for an animation. Present only when PIXOO_OUTPUT_DIR is configured."
    • addedOutput schema / properties / sourceFrames
      Added value: +{
      +  "description": "Frames in the source before sampling down to 40: 1 for a still.",
      +  "type": "number"
      +}
    • addedOutput schema / properties / speed
      Added value: +{
      +  "description": "Milliseconds per frame the animation plays at. Absent for a still.",
      +  "type": "number"
      +}
  4. Changed2 schema fields changedv1.2.0
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable. `device_rejected`: Device firmware returned a non-zero error code. `no_device_configured`: PIXOO_IP is not set. `asset_not_found`: Image path or URL could not be read. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable. `device_http_error`: The device answered with a non-2xx HTTP status (retryable for 408, 429, 500, and 502–504). `device_rejected`: Device firmware returned a non-zero error code. `no_device_configured`: PIXOO_IP is not set. `asset_not_found`: Image path or URL could not be read. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / error / properties / data / properties / reason / examples
      Previous value: -[
      -  "device_unreachable",
      -  "device_rejected",
      -  "no_device_configured",
      -  "asset_not_found"
      -]New value: +[
      +  "device_unreachable",
      +  "device_http_error",
      +  "device_rejected",
      +  "no_device_configured",
      +  "asset_not_found"
      +]
  5. Changed8 schema fields changedv1.1.1
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / additionalProperties
      Added value: +false
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedOutput schema / anyOf
      Added value: +[
      +  {
      +    "not": {
      +      "required": [
      +        "error"
      +      ]
      +    },
      +    "required": [
      +      "pushed"
      +    ]
      +  },
      +  {
      +    "required": [
      +      "error"
      +    ]
      +  }
      +]
    • addedOutput schema / properties / error
      Added value: +{
      +  "additionalProperties": {},
      +  "description": "Present when the call failed. Absent on success.",
      +  "properties": {
      +    "code": {
      +      "description": "JSON-RPC error code for this failure.",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "data": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "reason": {
      +          "description": "Machine-readable failure mode. Declared by this tool: `device_unreachable`: Device is not reachable. `device_rejected`: Device firmware returned a non-zero error code. `no_device_configured`: PIXOO_IP is not set. `asset_not_found`: Image path or URL could not be read. Other values are possible when a failure originates below the handler.",
      +          "examples": [
      +            "device_unreachable",
      +            "device_rejected",
      +            "no_device_configured",
      +            "asset_not_found"
      +          ],
      +          "type": "string"
      +        },
      +        "recovery": {
      +          "additionalProperties": {},
      +          "description": "Actionable next step for the caller.",
      +          "properties": {
      +            "hint": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "hint"
      +          ],
      +          "type": "object"
      +        },
      +        "retryable": {
      +          "description": "Whether retrying may succeed.",
      +          "type": "boolean"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "message": {
      +      "description": "Human-readable description of what went wrong.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "code",
      +    "message"
      +  ],
      +  "type": "object"
      +}
    • removedOutput schema / properties / previewData
      Removed value: -{
      -  "description": "Base64-encoded PNG preview of the downsampled 64×64 result (8× upscaled, 512px).",
      -  "type": "string"
      -}
    • removedOutput schema / properties / previewMimeType
      Removed value: -{
      -  "description": "MIME type of the preview image.",
      -  "enum": [
      -    "image/png"
      -  ],
      -  "type": "string"
      -}
    • removedOutput schema / required
      Removed value: -[
      -  "pushed"
      -]
  6. First observedv1.0.0

TDQS

A4.2/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations: it discloses that sources over 40 frames switch to a device-downloaded GIF, which requires the device to reach this host (PIXOO_SERVE_HOST/PIXOO_SERVE_PORT behind NAT), that speed then rounds to 10 ms, that sources are sampled evenly, and that the call returns a downsampled preview image block. Those are real operational constraints (network reachability) an agent cannot infer from openWorldHint/idempotentHint/destructiveHint.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the core action and scope in the first sentence, then layers animation, preview-return and rendering behavior. Dense but nearly every clause carries information; the closing color-quantization sentence is the one piece that largely duplicates schema text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a seven-parameter tool with nested enums and an output schema, the description covers the parts structured data cannot: the preview return, the 40-frame push threshold with its host-reachability requirement, and palette/finish effect on the preview. Nothing an agent needs to call this correctly appears missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the schema already documents fit, kernel, finish, dither and maxFrames in detail. The description's additions ('nearest-neighbor preserves pixel art', 'finish reduces to a small or fixed palette, optionally dithered', 'maxFrames default 40') largely restate the schema rather than adding new semantics, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb chain (load, resize, optionally push) against a concrete resource (image → LED grid), plus accepted input forms (absolute local path or https URL). This clearly separates it from siblings like pixoo_display_text, pixoo_overlay_text and pixoo_render_html, which handle text or HTML rather than an existing image file.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage context is implied by the push/optional framing and by guidance such as 'Nearest-neighbor kernel preserves pixel art; use lanczos3 or mitchell for photos', but that is parameter guidance, not tool selection. No sibling is named as an alternative, and no explicit when-not condition (e.g. when to prefer render_html or compose_scene) is given.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.