Skip to main content
Glama

read_preview_image

View a rendered preview image from the workspace previews directory. Supply the image path or filename to see the preview directly, bypassing the need to read the PNG file yourself.

Instructions

Return a rendered preview as an image so it can be looked at directly.

Use this when you cannot read the PNG from disk yourself; otherwise reading image_path with your own file tool is cheaper. Only reads from the workspace previews directory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
image_pathYesAbsolute path returned by render_preview, or just the filename of a file in workspace/previews

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations are absent, so the description carries the full behavioral burden. It clearly states the operation is read-only and restricted to the workspace previews directory. It stops short of describing output format or error behavior for missing files, but the safety profile is clear.

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?

Two tight sentences with the primary purpose front-loaded and the guidance immediately following. Every sentence adds value; there is no repetition or filler.

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?

For a one-parameter read-only tool, the description covers purpose, when to use it, an alternative, and directory constraints. With no output schema, the return format is implied ('as an image') but not fully specified, which keeps this from being a perfect 5.

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 description coverage is 100%, so the schema already explains image_path's accepted forms. The description adds usage context and path restrictions but no new parameter-level semantics beyond what the schema provides.

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 ('Return'), resource ('rendered preview'), and output form ('as an image'). The phrase 'Only reads from the workspace previews directory' scopes the tool and helps distinguish it from generic image/file-reading tools.

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?

Gives an explicit when-to-use condition ('when you cannot read the PNG from disk yourself') and names the alternative approach ('reading image_path with your own file tool') with a cost comparison. This is direct routing guidance with no ambiguity.

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