Skip to main content
Glama

pixelstream_configure_streamer

Configure local Pixel Streaming streamer by setting signalling URL, ports, render mode, and encoder bitrate.

Instructions

Configure local Pixel Streaming streamer URL, ports, render, and encoder settings.

KB: see knowledge_base/29_PIXEL_STREAMING_AND_REMOTE.md#mcp-pixel-streaming-tools Example: pixelstream_configure_streamer(signalling_url="ws://127.0.0.1:8888", streamer_id="LocalDemo")

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
streamer_idNoDefaultStreamer
signalling_urlNows://127.0.0.1:8888
signalling_portNo
web_server_portNo
render_offscreenNo
use_secure_websocketNo
encoder_target_bitrateNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It does not disclose side effects such as whether configuration persists, requires a restart, or validates inputs. 'Configure' implies mutation, but no behavioral details are given. The example shows a call but does not explain what happens on success or failure.

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?

The description is concise and to the point, with a clear first sentence. The KB link and example add useful context without bloat. It could be improved by structuring parameter details, but for its length it is efficient.

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

Completeness2/5

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

For a configuration tool with 7 parameters, all optional with defaults, the description is incomplete. It does not explain parameter relationships, prerequisites (e.g., Pixel Streaming plugin must be enabled), or the effect of the configuration. Sibling tools are not mentioned for differentiation. The output schema exists but is not shown, so the description should at least indicate expected outcome.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate. It mentions categories like URL, ports, render, and encoder settings, but does not map them to the actual parameters. For instance, it does not clarify the difference between signalling_url and signalling_port, or the meaning of render_offscreen. Parameter names are self-explanatory but the description adds little beyond them.

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?

The description clearly states the tool configures a local Pixel Streaming streamer, covering URL, ports, render, and encoder settings. This is a specific verb and resource, and it differentiates from sibling tools like pixelstream_configure_plugin and pixelstream_create_launch_profile by focusing on streamer-level configuration. The example further clarifies usage.

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

Usage Guidelines2/5

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

No explicit guidance on when to use this tool versus alternatives. It does not mention that pixelstream_configure_plugin should be used for plugin settings or that pixelstream_create_launch_profile is for launch profiles. The description only states what it does, not when to choose it. The KB link is not a substitute for direct guidance.

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