Skip to main content
Glama

typora_snapshot

Read-only

Create bounded, structured renderer snapshots with a short-lived snapshotRef and revision instead of returning full HTML, enabling safe inspection and debugging.

Instructions

Create a bounded structured renderer snapshot with a short-lived snapshotRef and revision; prefer this over returning complete HTML.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
maxNodesNo
selectorNo
targetIdNoRenderer targetId from typora_status; required when no single window is focused
maxTextCharsNo
rootSelectorNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered. The description adds genuine context beyond that: the snapshot is 'bounded' and carries a 'short-lived' snapshotRef, which signals lifecycle/expiry behavior an agent needs to know.

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?

A single dense sentence with the key intent and the HTML-alternative front-loaded. No padding, though one clause about the snapshotRef/revision lifecycle is slightly compressed.

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?

With no output schema, six sparsely-documented parameters, and 17% schema coverage, the description carries the burden but leaves large gaps: how snapshotRef/revision are consumed, what the snapshot contains, and what the parameters bound are all unexplained.

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 17% (only targetId is documented), yet the description explains none of the five undocumented parameters (limit, maxNodes, selector, rootSelector, maxTextChars). The vague word 'bounded' gestures at limits without clarifying any parameter.

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 ('Create') and resource ('bounded structured renderer snapshot') and names the outputs (snapshotRef, revision). This clearly differentiates the tool from returning raw HTML, though it does not distinguish it from nearby siblings like get_dom or query_selector.

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?

'Prefer this over returning complete HTML' gives an implied preference but frames the choice against an abstract technique rather than a named sibling tool. No when-to-use context for selecting this over get_dom/query_selector is provided.

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