All skills
figma avatar

/figma-use-figjam

@a5e7e04 official
by figmafigma/mcp-server-guide2k stars
194

This skill helps agents use Figma's use_figma MCP tool in the FigJam context. Can be used alongside figma-use which has foundational context for using the use_figma tool.

Use this Skill: https://skilld.dev/gh/figma/mcp-server-guide/figma-use-figjam

This session only. Nothing lands on disk.

SKILL.md

β‰ˆ47 tokens always: the name and description. β‰ˆ1.7k when used: this file. β‰ˆ36k more on demand in 13 files.

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 include figma-use-figjam in the comma-separated skillNames parameter when calling use_figma for FigJam operations. If this skill was loaded via an MCP resource, you MUST prefix the name with resource: (e.g. resource:figma-use-figjam). 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. 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 nodeIds (with one entry per upload) to attach uploads to existing FigJam nodes as fills; omit nodeIds to drop the images onto the board as new layers.

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

Source: SKILL.md on GitHub

No alerts16d3 checks Β· Risk SAFE
  • Gen Agent Trust Hub16d

    This skill provides documentation and code patterns for using Figma's official MCP tools in FigJam files. It is safe and contains no malicious code or instructions.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW Β· No issues

Signed by skilld at a5e7e04. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 19 hours ago.

Activeupdated last month
disable-model-invocation
false
  • MCP
  • figma
  • figjam
  • plugin-api
  • board-creation
  • collaborative-design
  • javascript

README badge

README badge for figma/mcp-server-guide/figma-use-figjam

Instructs the use_figma MCP tool for FigJam-specific operations: creating boards, sections, stickies, connectors, tables, and code blocks. Covers inspection via get_figjam, text mutations, image uploads, and positioning rules that differ from Figma Design files.

Generated from the current SKILL.md.

Do I call `figma.createPage()` in FigJam files?
No. FigJam files (figma.com/board/...) do not support `createPage()` and will throw a TypeError. FigJam has a single implicit page; use sections instead to organize content.
How do I inspect a FigJam file to get node IDs?
`get_figjam` is the inspection tool for FigJam files and returns the full node tree as XML with all IDs. Always call it upfront before writing `use_figma` code that references existing nodes, since `console.log` output from `use_figma` is not returned to the agent.
Can I use `get_metadata` on FigJam files?
No. `get_metadata` is design-mode only and will fail immediately on FigJam files with an 'unsupported for FigJam files' error.
How do I add images to a FigJam board?
`upload_assets` is the only supported way to add images to FigJam. Do not use `figma.createImage()` or `figma.createImageAsync()` from inside `use_figma`.
What is the canonical recipe for editing text in FigJam?
Load the font, await it, then mutate the text node, then return affected IDs. FigJam text nodes use varying default fonts (sticky/shape use Inter Medium, connector has no default), so always load the actual font from `node.text.fontName` rather than hardcoding a family.

Generated from the current SKILL.md. These answers refresh after source changes.