Skip to main content
Glama

Get FigJam

figma_local_get_figjam
Read-only

Retrieve a FigJam board node as XML to extract stickies, shapes, connectors, sections, text, tables, and colors for downstream analysis or conversion.

Instructions

Get the content of a FigJam board node as XML: stickies, shapes, connectors (with from/to node IDs), sections, text and tables, including their text and colors. If no node id is provided, use 0:1. Extract nodeId and fileKey from the URL, e.g. https://figma.com/board/:fileKey/:fileName?node-id=1-2. Only for FigJam files (URL path /board/).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "fileKey": "<fileKey>",
      "nodeId": "<nodeId>"
    },
    "name": "figma_local_get_figjam"
  }
}

Input Schema

NameRequiredDescriptionDefault
nodeIdYesThe ID of the node in the Figma document, eg. "123:456" or "123-456". Extract it from the URL's node-id query parameter. Do not pass an empty or guessed nodeId.
fileKeyYesThe key of the Figma file to use. If a URL is provided, extract the file key from it: for https://figma.com/design/:fileKey/:fileName?node-id=1-2 the fileKey is `:fileKey`. For https://figma.com/design/:fileKey/branch/:branchKey/:fileName use the branchKey. A full URL is also accepted.
clientLanguagesNoA comma separated list of programming languages used by the client in the current context, e.g. `javascript`, `html,css,typescript`. If you do not know, list `unknown`.
clientFrameworksNoA comma separated list of frameworks used by the client in the current context, e.g. `react`, `vue`, `django`. If you do not know, list `unknown`.
includeImagesOfNodesNoWhether to include an image of the node in the response. Defaults to true.

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 readOnlyHint=true and openWorldHint=true, so the safety profile is covered; the description adds genuinely new context about output format (XML), what node data is serialized, connector from/to node IDs, and the default nodeId behavior. It omits practical operational facts such as response size limits for large boards or whether images are inlined, which matters for a potentially huge read.

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?

Three tightly packed sentences: payload description first, then the default/URL extraction mechanics, then the file-type restriction. No filler, and each sentence carries callable information.

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?

With no output schema, the description correctly takes on the burden of describing the return value, and does so in detail. What remains thin is the behavior of includeImagesOfNodes in the response and any guidance on large-board payloads, but an agent has everything needed to make a correct call.

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 the baseline is 3 and the schema already documents all five parameters. The description does add one valuable detail the schema lacks: the `/board/:fileKey/:fileName?node-id=1-2` URL shape and the `0:1` nodeId default, since the schema's fileKey example only illustrates `/design/` URLs. That is useful supplementation but not enough to lift it well above 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?

"Get the content of a FigJam board node as XML" gives a specific verb plus resource, and the enumeration (stickies, shapes, connectors with from/to node IDs, sections, text, tables) tells the agent exactly what comes back. The closing "Only for FigJam files (URL path `/board/`)" is a concrete differentiator against the design-file siblings such as get_design_context or get_metadata.

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?

It states a clear applicability test (URL path must be `/board/`) and a fallback default nodeId of `0:1`, which is real when-to-use guidance. It stops short of naming the alternative tool to use for `/design/` URLs, so the agent must infer the routing decision rather than being routed explicitly.

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