openai/figma-use-figjam

use_figma — Figma Plugin API Skill for FigJam

This skill contains FigJam-specific context for the use_figma MCP tool. The figma-use skill provides foundational context for plugin API execution via MCP as well as the full Figma plugin API for more advanced use-cases that are not described here.

Always pass skillNames: "figma-use-figjam" when calling use_figma for FigJam operations. This is a logging parameter used to track skill usage — it does not affect execution.

FigJam URL is figma.com/board/.... Do NOT call figma.createPage() in FigJam — it throws TypeError: figma.createPage no such property 'createPage' on the figma global object. createPage() is a Design-file API only (figma.com/design/...). FigJam files have a single implicit page; organize content with sections instead (see create-section).

Inspecting FigJam Files

get_figjam is the inspection tool for FigJam files. It returns the full node tree as XML, including IDs of pages, sections, stickies, connectors, and other nodes you need to reference in subsequent use_figma calls.

• Use get_figjam upfront before writing any use_figma code that needs to reference existing nodes (page IDs, section IDs, etc.). Don't try to discover IDs by running an inspection script — console.log output from use_figma is not returned to the agent (see figma-use Critical Rule #4). Only the return value comes back.
• get_metadata does NOT work on FigJam files — it is design-mode only and will fail immediately with "unsupported for FigJam files".
• get_screenshot requires a valid nodeId — passing an empty nodeId returns "invalid nodeId" error. Get IDs from get_figjam first.
• If you forgot to return an ID from a previous use_figma call and need it now, call get_figjam rather than re-running an inspection script.

Loading Reference Docs Efficiently

Load only the references your task needs — but when you do need to load multiple, issue all reads in a single parallel tool-call batch, not sequentially across turns. For a typical board-creation task, that means a single message containing reads for plan-board-content plus the 3-4 specific node-type references you'll use.

Deferred Tools — Batch-Load Schemas

The Figma MCP tools (use_figma, get_figjam, get_screenshot, get_metadata, create_new_file, whoami) often appear as deferred tools that require ToolSearch to load their schemas before they can be called. Load all schemas in a single ToolSearch call using the select: syntax instead of one call per tool:

ToolSearch query="select:use_figma,get_figjam,get_screenshot,get_metadata,create_new_file"

Six sequential ToolSearch calls is six round trips before any work happens. One batched call is one round trip.

Text Mutations — Canonical Recipe

Every FigJam text mutation (sticky/shape/label/table cell/connector text, standalone text nodes) follows the same recipe as Design files: load font → await → mutate → return affected IDs. Skipping the load throws Cannot write to node with unloaded font "<family> <style>". See figma-use → gotchas.md → Canonical text-edit recipe. FigJam-specific note: sublayer defaults vary (sticky → Inter Medium, shape → Inter Medium, connector → invalid until set), so always load from node.text.fontName rather than hardcoding { family: 'Inter', style: 'Regular' }.

Adding Images to a FigJam Board

upload_assets is the ONLY supported way to add images to a FigJam file. Do NOT use figma.createImage() or figma.createImageAsync() from inside use_figma — they are unsupported as image-upload entry points in FigJam. Call upload_assets with the FigJam fileKey; the tool returns single-use upload URLs that you POST raw image bytes to, and the image is committed and placed automatically. Pass nodeId (with count: 1) to attach the upload to an existing FigJam node as a fill; omit nodeId to drop the image onto the board as a new layer.

For the full request/response shape, see figma-use → api-reference.md → Images.

Reference Docs

• plan-board-content - Read this for any board content request — board template, retro, brainstorm, ice breaker, meeting board, scaffold
  • Covers planning of generated board content, including sequential outline, sections, intents, and hierarchical text
  • Delegates to other references for specific API details
• create-section — Create and configure FigJam sections (sizing, naming, colors, content visibility, organizing nodes, column layouts)
• create-sticky — Create and configure FigJam sticky notes (colors, sizing, text, author visibility, batch creation)
• create-connector — Create and configure FigJam connectors (endpoints, arrows, line types, labels, colors, diagram wiring)
• create-text — Create and configure FigJam text nodes (font loading, preset fonts and colors, sizing, lists, mind map operations)
• position-figjam-nodes — Position, size, and reparent nodes on the canvas (including within sections)
• create-shape-with-text — Create and configure FigJam shapes with embedded text (shape types, color presets, sizing to fit text, diagram layouts)
• create-code-block — Create and configure FigJam code block nodes (languages, syntax highlighting, positioning, embedding in sections)
• create-table — Create and configure FigJam tables (rows, columns, cell text, color presets, resizing)
• edit-text — Edit existing text nodes (font loading, styled ranges, find/replace, FigJam Charcoal default color)
• create-label — Create and configure FigJam label nodes (small numbered/lettered circle callout markers, sequences, positioning)
• batch-modify — Patterns for modifying many existing nodes at once (bulk style changes, repositioning, property updates)
• figjam-colors — Canonical FigJam color palettes for every node type (sticky, section, connector, shape, label) plus the hex/255 notation rule and the h() helper