Skip to main content
Glama

figma_read_canvas

Read-onlyIdempotent

Reads the live, currently open Figma canvas as token-optimized JSX, tree, or JSON for direct inspection, avoiding custom tree-walk code.

Instructions

Read the LIVE, currently-open Figma document as token-optimized Pseudo-JSX/Tree/JSON — the same pipeline get_file/get_node use for the cloud API, applied to whatever is open in Figma Desktop right now. Prefer this over hand-writing a tree walk in figma_execute_code; it is far cheaper in tokens and its output format matches get_file/get_node exactly.

Input Schema

NameRequiredDescriptionDefault
depthNoTraversal depth from each requested node, hard-capped at 12 (default: 6).
formatNoOutput format — same meaning as get_file/get_node (default: 'jsx').
targetNofileName of a specific connected Figma document, when more than one is open (see figma_list_targets).
node_idsNoComma-separated node IDs to read. Omit to read the top-level frames of the current page.
budget_tokensNoTarget response size in tokens (default: 4000). If the requested depth overshoots this, depth is reduced and re-serialized (no extra round trip) until it fits, with a trailing comment noting the reduction.
include_hiddenNoWhether to include hidden (visible=false) layers (default: false).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower, and the description still adds real context: it reads live desktop state rather than cloud state, output format matches get_file/get_node, and token cost is bounded. It does not mention failure behavior when no document is open or how target resolution errors surface, which keeps it from a 5.

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 sentences, front-loaded with the distinguishing fact (LIVE document) before the comparison to siblings. No 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?

Six optional parameters with full schema coverage and no output schema, and the description covers the live-vs-cloud distinction, format parity and token budgeting. Minor gaps remain around multi-document targeting and no-document-open behavior, but nothing critical for correct invocation is missing.

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 coverage is 100%, so depth, format, target, node_ids, budget_tokens and include_hidden are all already documented. The description reinforces that the output format semantics are identical to get_file/get_node, which helps interpret the format enum, but adds no new per-parameter detail beyond the schema baseline.

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 (read) and a precisely scoped resource (the LIVE, currently-open Figma document) with the output shape (Pseudo-JSX/Tree/JSON). It also distinguishes itself from the cloud-API siblings get_file/get_node and from figma_execute_code, so an agent can pick it without opening a schema.

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

Usage Guidelines4/5

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

Explicitly says to prefer this over hand-writing a tree walk in figma_execute_code and gives the reason (cheaper, format parity). It does not spell out the complementary case (use get_file/get_node when the document is not open locally) or point to figma_list_targets for multi-document targeting in the prose, so the routing guidance is clear but not exhaustive.

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