pixoo-mcp-server

Overview Schema Source Related Servers Discussions Admin

pixoo_overlay_text

pixoo_overlay_text

Idempotent

Set or clear persistent scrolling text overlays on Pixoo LED displays. Use slots to add or remove device-rendered tickers that remain across channel switches.

Instructions

Set or clear a device-native scrolling text overlay. Use mode "set" to add or update an overlay on a slot (0–19); use mode "clear" to remove it. Overlays use device-rendered fonts (115 font IDs, 0–114) and persist across channel switches until explicitly cleared with mode "clear". Not previewable — rendering happens on-device. Best for persistent tickers over pushed scenes; for styled, previewable text use pixoo_display_text instead.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`x`	No	X start position, 0 to display size − 1 (63 on a 64px display; default: 0).
`y`	No	Y start position, 0 to display size − 1 (63 on a 64px display; default: 0).
`id`	Yes	Overlay slot ID (0–19). Each ID is an independent overlay layer.
`font`	No	Device font ID (0–114). 0 = default, 18 = arrows, 20 = °C/°F. Device-rendered; no preview.
`mode`	Yes	set = add/update overlay; clear = remove it.
`text`	No	Text to display (required for mode=set).
`align`	No	Text alignment (default: left).	left
`color`	No	Text color: hex (#RRGGBB or #RGB) or a named color such as orange (default: white).	#ffffff
`speed`	No	Scroll speed (0–100, device units; default: 50).
`width`	No	Text region width in pixels, 0 to display size (64 on a 64px display; defaults to display width).
`direction`	No	Scroll direction (default: left).	left

Output Schema

TableJSON Schema

Name	Required	Description
`id`	No	The overlay slot ID (0–19) that was operated on.
`mode`	No	Operation performed: "set" (overlay added/updated) or "clear" (overlay removed).
`error`	No	Present when the call failed. Absent on success.
`acknowledged`	No	True when the device confirmed the overlay command (error_code: 0).

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv1.2.0Sep 25, 2026

changedInput schema / properties / color / description

Previous value: -"Text color as CSS hex color (default: white)."New value: +"Text color: hex (#RRGGBB or #RGB) or a named color such as orange (default: white)."

changedInput schema / properties / width / description

Previous value: -"Text region width in pixels (optional; defaults to display width)."New value: +"Text region width in pixels, 0 to display size (64 on a 64px display; defaults to display width)."

changedInput schema / properties / x / description

Previous value: -"X start position on display (default: 0)."New value: +"X start position, 0 to display size − 1 (63 on a 64px display; default: 0)."

changedInput schema / properties / y / description

Previous value: -"Y start position on display (default: 0)."New value: +"Y start position, 0 to display size − 1 (63 on a 64px display; default: 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 rejected the command. `no_device_configured`: PIXOO_IP is not set. `invalid_color`: The color value could not be resolved. 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 rejected the command. `no_device_configured`: PIXOO_IP is not set. `invalid_color`: The color value could not be resolved. 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",
-  "invalid_color"
-]New value: +[
+  "device_unreachable",
+  "device_http_error",
+  "device_rejected",
+  "no_device_configured",
+  "invalid_color"
+]

Changed6 schema fields changedv1.1.1Aug 24, 2026

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": [
+      "acknowledged",
+      "mode",
+      "id"
+    ]
+  },
+  {
+    "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 rejected the command. `no_device_configured`: PIXOO_IP is not set. `invalid_color`: The color value could not be resolved. Other values are possible when a failure originates below the handler.",
+          "examples": [
+            "device_unreachable",
+            "device_rejected",
+            "no_device_configured",
+            "invalid_color"
+          ],
+          "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 / required

Removed value: -[
-  "acknowledged",
-  "mode",
-  "id"
-]

First observedv1.0.0Jun 17, 2026

TDQS

A4.9/5.0

Behavior5/5

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

Adds valuable behavioral context beyond the annotations: overlays persist across channel switches, are device-rendered, and are not previewable. The description also makes clear that removal happens via mode 'clear'. No contradiction with the idempotentHint or destructiveHint annotations.

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

Conciseness5/5

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

Three focused sentences front-load the core operation, then add persistence and preview constraints, and close with a routing pointer. Every sentence earns its place without redundancy.

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 complex 11-parameter tool with a full output schema and complete property descriptions, the description covers the essential behavioral and routing information. The combination of description, schema, and annotations leaves no critical gap for correct invocation.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds meaning by explaining the mode enum ('set' = add/update, 'clear' = remove) and the slot persistence semantics. It doesn't elaborate on x/y/speed/etc., but the schema already covers those with defaults and ranges.

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 ('Set or clear') and a specific resource ('device-native scrolling text overlay'), plus the slot range. It clearly distinguishes itself from pixoo_display_text, so an agent can tell them apart without opening the schema.

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

Usage Guidelines5/5

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

Explicitly says this is 'best for persistent tickers over pushed scenes' and names the alternative for styled/previewable text ('use pixoo_display_text instead'). It also explains when to use mode 'set' vs 'clear', giving the agent clear routing guidance.

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

Deploy Server