Skip to main content
Glama
paragdesai1

Cursor Talk to Figma MCP

by paragdesai1

set_annotation

Add or edit annotations on Figma design elements to document specifications, feedback, or instructions within Cursor AI workflows.

Instructions

Create or update an annotation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nodeIdYesThe ID of the node to annotate
annotationIdNoThe ID of the annotation to update (if updating existing annotation)
labelMarkdownYesThe annotation text in markdown format
categoryIdNoThe ID of the annotation category
propertiesNoAdditional properties for the annotation

Implementation Reference

  • Core handler function that implements set_annotation tool logic in Figma plugin: validates params, retrieves node, constructs Figma annotation object, sets node.annotations array overwriting existing, returns success with updated info.
    async function setAnnotation(params) {
      try {
        console.log("=== setAnnotation Debug Start ===");
        console.log("Input params:", JSON.stringify(params, null, 2));
    
        const { nodeId, annotationId, labelMarkdown, categoryId, properties } =
          params;
    
        // Validate required parameters
        if (!nodeId) {
          console.error("Validation failed: Missing nodeId");
          return { success: false, error: "Missing nodeId" };
        }
    
        if (!labelMarkdown) {
          console.error("Validation failed: Missing labelMarkdown");
          return { success: false, error: "Missing labelMarkdown" };
        }
    
        console.log("Attempting to get node:", nodeId);
        // Get and validate node
        const node = await figma.getNodeByIdAsync(nodeId);
        console.log("Node lookup result:", {
          id: nodeId,
          found: !!node,
          type: node ? node.type : undefined,
          name: node ? node.name : undefined,
          hasAnnotations: node ? "annotations" in node : false,
        });
    
        if (!node) {
          console.error("Node lookup failed:", nodeId);
          return { success: false, error: `Node not found: ${nodeId}` };
        }
    
        // Validate node supports annotations
        if (!("annotations" in node)) {
          console.error("Node annotation support check failed:", {
            nodeType: node.type,
            nodeId: node.id,
          });
          return {
            success: false,
            error: `Node type ${node.type} does not support annotations`,
          };
        }
    
        // Create the annotation object
        const newAnnotation = {
          labelMarkdown,
        };
    
        // Validate and add categoryId if provided
        if (categoryId) {
          console.log("Adding categoryId to annotation:", categoryId);
          newAnnotation.categoryId = categoryId;
        }
    
        // Validate and add properties if provided
        if (properties && Array.isArray(properties) && properties.length > 0) {
          console.log(
            "Adding properties to annotation:",
            JSON.stringify(properties, null, 2)
          );
          newAnnotation.properties = properties;
        }
    
        // Log current annotations before update
        console.log("Current node annotations:", node.annotations);
    
        // Overwrite annotations
        console.log(
          "Setting new annotation:",
          JSON.stringify(newAnnotation, null, 2)
        );
        node.annotations = [newAnnotation];
    
        // Verify the update
        console.log("Updated node annotations:", node.annotations);
        console.log("=== setAnnotation Debug End ===");
    
        return {
          success: true,
          nodeId: node.id,
          name: node.name,
          annotations: node.annotations,
        };
      } catch (error) {
        console.error("=== setAnnotation Error ===");
        console.error("Error details:", {
          message: error.message,
          stack: error.stack,
          params: JSON.stringify(params, null, 2),
        });
        return { success: false, error: error.message };
      }
    }
  • MCP server.tool registration for 'set_annotation': defines input schema with Zod validation, provides proxy handler that sends command to Figma plugin via websocket, handles response/error formatting.
    server.tool(
      "set_annotation",
      "Create or update an annotation",
      {
        nodeId: z.string().describe("The ID of the node to annotate"),
        annotationId: z.string().optional().describe("The ID of the annotation to update (if updating existing annotation)"),
        labelMarkdown: z.string().describe("The annotation text in markdown format"),
        categoryId: z.string().optional().describe("The ID of the annotation category"),
        properties: z.array(z.object({
          type: z.string()
        })).optional().describe("Additional properties for the annotation")
      },
      async ({ nodeId, annotationId, labelMarkdown, categoryId, properties }) => {
        try {
          const result = await sendCommandToFigma("set_annotation", {
            nodeId,
            annotationId,
            labelMarkdown,
            categoryId,
            properties
          });
          return {
            content: [
              {
                type: "text",
                text: JSON.stringify(result)
              }
            ]
          };
        } catch (error) {
          return {
            content: [
              {
                type: "text",
                text: `Error setting annotation: ${error instanceof Error ? error.message : String(error)}`
              }
            ]
          };
        }
      }
    );
  • Input schema for set_annotation tool using Zod: requires nodeId and labelMarkdown, optional annotationId, categoryId, and properties array.
      nodeId: z.string().describe("The ID of the node to annotate"),
      annotationId: z.string().optional().describe("The ID of the annotation to update (if updating existing annotation)"),
      labelMarkdown: z.string().describe("The annotation text in markdown format"),
      categoryId: z.string().optional().describe("The ID of the annotation category"),
      properties: z.array(z.object({
        type: z.string()
      })).optional().describe("Additional properties for the annotation")
    },
  • Dispatch registration in Figma plugin's handleCommand switch statement: routes 'set_annotation' command to setAnnotation handler function.
    case "set_annotation":
      return await setAnnotation(params);
    case "scan_nodes_by_types":
      return await scanNodesByTypes(params);
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. While 'create or update' implies mutation, it doesn't specify whether this operation is destructive, requires authentication, has rate limits, or what happens on conflicts. For a mutation tool with zero annotation coverage, this is a significant gap in transparency.

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?

The description is a single, efficient sentence that gets straight to the point with zero wasted words. It's appropriately sized and front-loaded, making it easy to parse quickly without unnecessary elaboration.

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

Completeness2/5

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

For a mutation tool with 5 parameters, no annotations, and no output schema, the description is inadequate. It doesn't explain return values, error conditions, or behavioral nuances like whether updates are idempotent. The combination of missing annotations and sparse description leaves significant gaps for an AI agent to understand tool behavior.

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 parameters thoroughly. The description adds no additional parameter semantics beyond what's in the schema, such as explaining the relationship between 'nodeId' and 'annotationId' or clarifying when 'annotationId' is required. Baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('create or update') and resource ('an annotation'), making the purpose immediately understandable. However, it doesn't differentiate this tool from its sibling 'set_multiple_annotations' or explain how it differs from 'get_annotations', leaving room for improvement in sibling distinction.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'set_multiple_annotations' for batch operations or 'get_annotations' for retrieval. It also lacks context about prerequisites, such as whether the node must exist or if specific permissions are required.

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

Install Server

Other Tools

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/paragdesai1/parag-Figma-MCP'

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