Skip to main content
Glama
Sign In
pixoo-mcp-server

pixoo-mcp-server

by cyanheads
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

pixoo_design_brief

pixoo_design_brief
Read-only

Retrieve design guidance for Pixoo LED projects. Get legibility rules, layout zones, and device context for text, scenes, dashboards, animations, or HTML pages before authoring.

Instructions

Return craft guidance and live device context for a design topic. Covers legibility rules, palette discipline, layout zones, animation budget, HTML page authoring, and pre-filled next-tool suggestions based on current device state. The orientation tool to run before authoring a scene, dashboard, animation, or HTML page — or when troubleshooting display issues.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "topic": "<topic>"
    },
    "name": "pixoo_design_brief"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicYesDesign topic: text (styled text guidance), scene (composition + layout zones), dashboard (widgets + metrics), animation (motion budget + effects), pixel-art (bitmap + sprite guidance), html (pixoo_render_html pages: loops, clock, sampling), troubleshooting (device + display issues).

Output Schema

NameRequiredDescriptionDefault
errorNoPresent when the call failed. Absent on success.
topicNoThe topic that was requested.
htmlRendererNoWhether pixoo_render_html can render: available; disabled (PIXOO_HTML_ENABLED=false, so the tool is not listed); or no_browser (no browser found, so the tool fails browser_unavailable until one is installed).
craftGuidanceNoMarkdown-formatted craft rules: legibility floors, palette discipline, layout zones, and technique guidance specific to the topic.
deviceContextNoLive device state snapshot at the time of the request.
iconCategoriesNoBuilt-in icon names grouped by category (weather, arrows, status, media). Use names in pixoo_compose_scene icon elements.
availableThemesNoAvailable named scene themes (e.g. "midnight", "ember"). Use in background.theme or pixoo_display_text theme param.
nextToolSuggestionsNoSuggested next steps based on topic and device state.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.5.0
    • changedOutput schema / properties / deviceContext / properties / displaySize / description
      Previous value: -"Configured display canvas size in pixels (16, 32, or 64). Design coordinates scale to this value."New value: +"Configured display canvas size in pixels (16, 32, or 64). Coordinates are panel pixels and do not scale: lay out for this size."
    • changedOutput schema / properties / deviceContext / properties / reachable / description
      Previous value: -"True if device is currently reachable. When false, push: false is implied for all render tools."New value: +"True if the device answered. False both when no device is configured and when the configured one does not answer; pixoo://device/status configuredIp (null when unconfigured) tells them apart. Render tools still default to push: true, so pass push: false while this is false."
  2. Changed4 schema fields changedv1.4.0
    • changedInput schema / properties / topic / description
      Previous value: -"Design topic: text (styled text guidance), scene (composition + layout zones), dashboard (widgets + metrics), animation (motion budget + effects), pixel-art (bitmap + sprite guidance), troubleshooting (device + display issues)."New value: +"Design topic: text (styled text guidance), scene (composition + layout zones), dashboard (widgets + metrics), animation (motion budget + effects), pixel-art (bitmap + sprite guidance), html (pixoo_render_html pages: loops, clock, sampling), troubleshooting (device + display issues)."
    • changedInput schema / properties / topic / enum
      Previous value: -[
-  "text",
-  "scene",
-  "dashboard",
-  "animation",
-  "pixel-art",
-  "troubleshooting"
-]New value: +[
+  "text",
+  "scene",
+  "dashboard",
+  "animation",
+  "pixel-art",
+  "html",
+  "troubleshooting"
+]
    • changedOutput schema / anyOf
      Previous value: -[
-  {
-    "not": {
-      "required": [
-        "error"
-      ]
-    },
-    "required": [
-      "topic",
-      "craftGuidance",
-      "deviceContext",
-      "nextToolSuggestions",
-      "availableThemes",
-      "iconCategories"
-    ]
-  },
-  {
-    "required": [
-      "error"
-    ]
-  }
-]New value: +[
+  {
+    "not": {
+      "required": [
+        "error"
+      ]
+    },
+    "required": [
+      "topic",
+      "craftGuidance",
+      "deviceContext",
+      "htmlRenderer",
+      "nextToolSuggestions",
+      "availableThemes",
+      "iconCategories"
+    ]
+  },
+  {
+    "required": [
+      "error"
+    ]
+  }
+]
    • addedOutput schema / properties / htmlRenderer
      Added value: +{
+  "description": "Whether pixoo_render_html can render: available; disabled (PIXOO_HTML_ENABLED=false, so the tool is not listed); or no_browser (no browser found, so the tool fails browser_unavailable until one is installed).",
+  "enum": [
+    "available",
+    "disabled",
+    "no_browser"
+  ],
+  "type": "string"
+}
  3. Changed8 schema fields changedv1.2.0
    • changedOutput schema / properties / nextToolSuggestions / items / description
      Previous value: -"A suggested next-step tool with rationale and optional pre-filled args."New value: +"A recommended follow-up call with its arguments pre-filled."
    • addedOutput schema / properties / nextToolSuggestions / items / properties / args
      Added value: +{
+  "additionalProperties": {},
+  "description": "Pre-filled arguments for the call; {} when the tool needs none.",
+  "properties": {},
+  "type": "object"
+}
    • removedOutput schema / properties / nextToolSuggestions / items / properties / rationale
      Removed value: -{
-  "description": "Why this tool is relevant given current state.",
-  "type": "string"
-}
    • addedOutput schema / properties / nextToolSuggestions / items / properties / reason
      Added value: +{
+  "description": "Why this step is recommended given the current device state.",
+  "type": "string"
+}
    • removedOutput schema / properties / nextToolSuggestions / items / properties / suggestedArgs
      Removed value: -{
-  "additionalProperties": {},
-  "description": "Pre-filled argument suggestions as a key-value object.",
-  "properties": {},
-  "type": "object"
-}
    • removedOutput schema / properties / nextToolSuggestions / items / properties / tool
      Removed value: -{
-  "description": "Tool name to try next.",
-  "type": "string"
-}
    • addedOutput schema / properties / nextToolSuggestions / items / properties / toolName
      Added value: +{
+  "description": "Tool to call next.",
+  "type": "string"
+}
    • changedOutput schema / properties / nextToolSuggestions / items / required
      Previous value: -[
-  "tool",
-  "rationale"
-]New value: +[
+  "toolName",
+  "reason",
+  "args"
+]
  4. Changed6 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": [
+      "topic",
+      "craftGuidance",
+      "deviceContext",
+      "nextToolSuggestions",
+      "availableThemes",
+      "iconCategories"
+    ]
+  },
+  {
+    "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.",
+          "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: -[
-  "topic",
-  "craftGuidance",
-  "deviceContext",
-  "nextToolSuggestions",
-  "availableThemes",
-  "iconCategories"
-]
  5. First observedv1.0.0

TDQS

A4.1/5.0
Behavior4/5

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

readOnlyHint=true already frames it as a safe read; the description adds real behavioral context beyond that — it returns live device state and pre-filled next-tool suggestions, so the agent knows output is state-dependent, not static docs. It does not say what happens if no device is connected or discovered, which is the main undisclosed behavior.

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-loaded with the core verb and resource, then scoped by the coverage list and the 'run before authoring' trigger. Three sentences with no filler, though the middle coverage enumeration is dense and partly restates the enum values.

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

Completeness4/5

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

Output schema exists, so return values need no prose, and the description covers purpose, trigger, and state-dependence. The one gap for a tool that depends on live device state is whether pixoo_discover_devices must be run first — that prerequisite is implied but never stated.

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 coverage is 100% and the topic enum is fully documented in the schema, so baseline 3 applies. The description confirms the topic drives the returned guidance but adds no enum-level meaning (e.g., which topic fits a troubleshooting-vs-text decision) beyond what the schema already states.

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 and resource: return craft guidance plus live device context for a named design topic, and enumerates what that guidance covers. An agent can tell from the description alone that this is an advisory/orientation tool, not one of the pixoo_compose_scene / pixoo_display_text rendering siblings.

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

Usage Guidelines4/5

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

Gives an explicit trigger: run it before authoring a scene, dashboard, animation, or HTML page, or when troubleshooting display issues. It stops short of naming the sibling tools to call afterward or stating when it should be skipped, so it is clear context rather than a full when/when-not/alternative map.

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

Deploy Server

Other Tools