Skip to main content
Glama
neozhehan

Figma Edit MCP

by neozhehan

List Annotations

annotation_list
Read-only

Read native annotations from a Figma page or node. Optionally include file-wide annotation categories in the result.

Instructions

Read the native annotations on a page or node (and subtree); exactly one of pageId or nodeId is required. The file's annotation categories are returned by default; pass includeCategories: false to omit them. Page loading is bounded; a page-scoped failure returns its structured error directly and successful reads include coverage.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nodeIdNoThe node ID to get annotations from. Exactly one of pageId or nodeId is required.
pageIdNoThe page ID to get annotations from. Exactly one of pageId or nodeId is required.
includeCategoriesNoInclude the file's global annotation categories in the result. Defaults to true; pass false to omit them.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
coverageNoPage-scan coverage; partial read data remains usable when complete is false
categoriesNoList of global annotation categories
annotatedNodesNoGrouped annotations, preserving the owning node in page and node modes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed9 schema fields changedv2.3.3
    • changedInput schema / properties / includeCategories / description
      Previous value: -"If true, retrieves the list of global annotation categories in the file"New value: +"Include the file's global annotation categories in the result. Defaults to true; pass false to omit them."
    • addedOutput schema / properties / annotatedNodes
      Added value: +{
      +  "description": "Grouped annotations, preserving the owning node in page and node modes",
      +  "items": {
      +    "additionalProperties": {},
      +    "properties": {
      +      "annotations": {
      +        "description": "Annotations owned by this node",
      +        "items": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "categoryId": {
      +              "type": "string"
      +            },
      +            "label": {
      +              "description": "Optional plain-text annotation label",
      +              "type": "string"
      +            },
      +            "labelMarkdown": {
      +              "description": "Optional Markdown annotation label",
      +              "type": "string"
      +            },
      +            "properties": {
      +              "items": {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "type": {
      +                    "enum": [
      +                      "width",
      +                      "height",
      +                      "maxWidth",
      +                      "minWidth",
      +                      "maxHeight",
      +                      "minHeight",
      +                      "fills",
      +                      "strokes",
      +                      "effects",
      +                      "strokeWeight",
      +                      "cornerRadius",
      +                      "textStyleId",
      +                      "textAlignHorizontal",
      +                      "fontFamily",
      +                      "fontStyle",
      +                      "fontSize",
      +                      "fontWeight",
      +                      "lineHeight",
      +                      "letterSpacing",
      +                      "itemSpacing",
      +                      "padding",
      +                      "layoutMode",
      +                      "alignItems",
      +                      "opacity",
      +                      "mainComponent",
      +                      "gridRowGap",
      +                      "gridColumnGap",
      +                      "gridRowCount",
      +                      "gridColumnCount",
      +                      "gridRowAnchorIndex",
      +                      "gridColumnAnchorIndex",
      +                      "gridRowSpan",
      +                      "gridColumnSpan"
      +                    ],
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "type"
      +                ],
      +                "type": "object"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "name": {
      +        "description": "Current name of the owning node",
      +        "type": "string"
      +      },
      +      "nodeId": {
      +        "description": "ID of the node that owns these annotations",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "nodeId",
      +      "name",
      +      "annotations"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • removedOutput schema / properties / annotations
      Removed value: -{
      -  "description": "List of annotations",
      -  "items": {},
      -  "type": "array"
      -}
    • addedOutput schema / properties / categories / items / additionalProperties
      Added value: +{}
    • addedOutput schema / properties / categories / items / properties
      Added value: +{
      +  "color": {
      +    "enum": [
      +      "yellow",
      +      "orange",
      +      "red",
      +      "pink",
      +      "violet",
      +      "blue",
      +      "teal",
      +      "green"
      +    ],
      +    "type": "string"
      +  },
      +  "id": {
      +    "type": "string"
      +  },
      +  "isPreset": {
      +    "type": "boolean"
      +  },
      +  "label": {
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / categories / items / required
      Added value: +[
      +  "id",
      +  "label",
      +  "color",
      +  "isPreset"
      +]
    • addedOutput schema / properties / categories / items / type
      Added value: +"object"
    • addedOutput schema / properties / coverage
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "complete": {
      +          "const": true,
      +          "description": "Every attempted page succeeded",
      +          "type": "boolean"
      +        },
      +        "pageErrors": {
      +          "description": "Empty: no page failed",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "error": {
      +                "additionalProperties": false,
      +                "description": "Structured per-page failure",
      +                "properties": {
      +                  "code": {
      +                    "description": "Stable machine-readable failure code (see the error playbook)",
      +                    "type": "string"
      +                  },
      +                  "details": {
      +                    "description": "Optional structured context (e.g. partialMutation, before-values)"
      +                  },
      +                  "message": {
      +                    "description": "Human/agent-readable message embedding its own recovery",
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "code",
      +                  "message"
      +                ],
      +                "type": "object"
      +              },
      +              "pageId": {
      +                "description": "ID of the page that could not be loaded, resolved, or read",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "pageId",
      +              "error"
      +            ],
      +            "type": "object"
      +          },
      +          "maxItems": 0,
      +          "type": "array"
      +        },
      +        "pagesAttempted": {
      +          "description": "Distinct pages this call tried to resolve, load, or read. 0 means the result required no page access at all — it does NOT mean the document was checked and found clean.",
      +          "maximum": 9007199254740991,
      +          "minimum": 0,
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "complete",
      +        "pagesAttempted",
      +        "pageErrors"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "complete": {
      +          "const": false,
      +          "description": "At least one attempted page failed",
      +          "type": "boolean"
      +        },
      +        "pageErrors": {
      +          "description": "Structured failures for pages omitted from this result; successful pages are still returned",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "error": {
      +                "additionalProperties": false,
      +                "description": "Structured per-page failure",
      +                "properties": {
      +                  "code": {
      +                    "description": "Stable machine-readable failure code (see the error playbook)",
      +                    "type": "string"
      +                  },
      +                  "details": {
      +                    "description": "Optional structured context (e.g. partialMutation, before-values)"
      +                  },
      +                  "message": {
      +                    "description": "Human/agent-readable message embedding its own recovery",
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "code",
      +                  "message"
      +                ],
      +                "type": "object"
      +              },
      +              "pageId": {
      +                "description": "ID of the page that could not be loaded, resolved, or read",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "pageId",
      +              "error"
      +            ],
      +            "type": "object"
      +          },
      +          "minItems": 1,
      +          "type": "array"
      +        },
      +        "pagesAttempted": {
      +          "description": "Distinct pages this call tried to resolve, load, or read. 0 means the result required no page access at all — it does NOT mean the document was checked and found clean.",
      +          "maximum": 9007199254740991,
      +          "minimum": 0,
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "complete",
      +        "pagesAttempted",
      +        "pageErrors"
      +      ],
      +      "type": "object"
      +    }
      +  ],
      +  "description": "Page-scan coverage; partial read data remains usable when complete is false"
      +}
    • addedOutput schema / properties / error
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "code": {
      +      "description": "Stable machine-readable failure code (see the error playbook)",
      +      "type": "string"
      +    },
      +    "details": {
      +      "description": "Optional structured context (e.g. partialMutation, before-values)"
      +    },
      +    "message": {
      +      "description": "Human/agent-readable message embedding its own recovery",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "code",
      +    "message"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changedv2.3.2
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
  3. Changed1 schema field changedv2.3.0
    • addedInput schema / additionalProperties
      Added value: +false
  4. Changed3 schema fields changedv2.1.0
    • changedInput schema / properties / nodeId / description
      Previous value: -"The node ID to get annotations from"New value: +"The node ID to get annotations from. Exactly one of pageId or nodeId is required."
    • addedInput schema / properties / pageId
      Added value: +{
      +  "description": "The page ID to get annotations from. Exactly one of pageId or nodeId is required.",
      +  "type": "string"
      +}
    • removedInput schema / required
      Removed value: -[
      -  "nodeId"
      -]
  5. Addedv2.0.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations declare readOnlyHint and openWorldHint, but the description adds meaningful behavioral details: 'Page loading is bounded; a page-scoped failure returns its structured error directly and successful reads include `coverage`.' This goes beyond the annotation and informs the agent about edge cases and return characteristics.

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 sentences, each serving a distinct purpose: scope, parameter constraints, and behavioral edge cases. The description is front-loaded with the core action and is free of fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (3 params, output schema exists), the description covers all essential aspects: the resource being read, the parameter exclusivity, optional categories, and potential partial failure behavior. No important gaps remain.

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 description coverage is 100%, so the schema already documents all three parameters. The description reinforces the mutual exclusivity and default for includeCategories but adds no new semantic details beyond what the schema provides, so baseline 3 is appropriate.

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?

The description opens with 'Read the native annotations on a page or node (and subtree)', which is a specific verb and resource. It clearly distinguishes this read tool from the sibling write tool annotation_set and other list-style tools like style_list or variable_list.

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?

The description states the core usage rule ('exactly one of pageId or nodeId is required') and mentions the includeCategories toggle. While it doesn't explicitly say when not to use it, the read-only intent and sibling set (annotation_set for writing) imply appropriate usage clearly.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/neozhehan/figma-edit-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server