Skip to main content
Glama

trmnl_get_mashup_options

Read-onlyIdempotent

Read preset layouts and compatible plugin settings for a device mashup, so you can select valid display options before configuration.

Instructions

Read preset layouts and compatible plugin settings TRMNL GET /api/devices/{device_id}/mashups/options.

Input Schema

NameRequiredDescriptionDefault
pathYes
queryNo
profileNoConfigured profile name; defaults to default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

B3/5.0
Behavior3/5

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

The annotations already establish that this is a read-only, idempotent, non-destructive operation, so the description does not need to repeat safety details. It adds useful context about what is read (preset layouts and compatible plugin settings) but says nothing about authentication, rate limits, or response shape.

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 short and front-loads the main purpose. The second line mostly restates the endpoint already implied by the structured path, but it is compact and not distracting.

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

Completeness3/5

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

For a read-only options-listing tool with no output schema and nested path parameters, the description conveys the general return content but leaves mashup_id semantics and output details ambiguous. It is adequate but not complete.

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 only 33%, so the description should compensate for undocumented parameters. The endpoint path clarifies that device_id is used, but the optional mashup_id query parameter is never explained, and profile is only described in the schema.

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

Purpose4/5

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

The description uses a clear verb ('Read') and specifies the resource ('preset layouts and compatible plugin settings'), with the endpoint clarifying the device-scoped mashup context. It does not explicitly distinguish itself from nearby siblings such as trmnl_get_mashup or trmnl_get_mashup_timeline, but the purpose is still understandable.

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?

The description gives no explicit guidance on when to use this tool versus alternatives like trmnl_get_mashup or trmnl_get_plugin_configuration_choices. Usage is only weakly inferable from the phrase 'preset layouts and compatible plugin settings'.

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