Skip to main content
Glama

trmnl_get_preview

Read-onlyIdempotent

Retrieve the rendered preview result for a TRMNL plugin setting by job ID, so you can inspect the generated screenshot before deployment.

Instructions

Read the result of a preview render TRMNL GET /api/plugin_settings/{plugin_setting_id}/screenshots/{id}.

Input Schema

NameRequiredDescriptionDefault
pathYes
profileNoConfigured profile name; defaults to default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and openWorld, so the safety profile is covered. The description adds only the endpoint mapping; it does not say what happens if the render is not yet complete, whether the result expires, or what the response contains.

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?

Two short lines, front-loaded with the action and followed by the endpoint reference. No wasted words, though the brevity reflects under-specification rather than disciplined editing.

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?

There is no output schema, so the description must explain what a preview result looks like (image URL, status, expiry), and it does not. For a nested-object read tool whose main failure mode is 'render not ready yet', this leaves the agent guessing.

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 coverage is 50% and the description contributes nothing beyond the URL template — the nested 'path' object is undocumented in both places, and 'profile' is left entirely to the schema. Given the coverage gap, the description should have clarified that path.id is the screenshot id/job_id and how it relates to plugin_setting_id.

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?

States a specific verb and resource ('Read the result of a preview render') and anchors it to the concrete endpoint GET /api/plugin_settings/{plugin_setting_id}/screenshots/{id}. An agent can tell it apart from trmnl_start_preview by the 'read the result' framing, though the sibling is never named.

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 is only implied: the phrase 'the result of a preview render' hints that this is called after a render is started, and the schema's 'job_id returned when the render was started' reinforces that. But there is no explicit when-to-use, no mention of trmnl_start_preview or trmnl_project_preview as alternatives, and no guidance on polling or retry.

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