Skip to main content
Glama
neozhehan

Figma Edit MCP

List Annotations

annotation_list
Read-only

Retrieves annotations from a specified Figma page or node, with an option to include global annotation categories.

Instructions

Read the native annotations on a page or node (and subtree); exactly one of pageId or nodeId is required. Optionally include the file's annotation categories.

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.
includeCategoriesNoIf true, retrieves the list of global annotation categories in the file

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
categoriesNoList of global annotation categories
annotationsNoList of annotations
Behavior4/5

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

The description adds detail beyond annotations (readOnlyHint, openWorldHint) by specifying that subtree annotations are included for nodes and that categories can be optionally retrieved. It does not contradict annotations and provides meaningful behavioral context.

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 two sentences, front-loaded with the core purpose and constraint, and every word adds value. No unnecessary elaboration.

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?

Given the presence of output schema, annotations, and relatively simple parameters, the description adequately covers the essential behavior and constraints. It could clarify subtree behavior for pageId, but overall it is sufficient for an agent to understand the tool.

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 all parameters are already documented. The description restates the mutual exclusivity of pageId and nodeId and the optional nature of includeCategories, but adds no new semantic information beyond what is in the schema.

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 clearly states it reads native annotations on a page or node (and subtree), differentiating it from sibling tools like annotation_set (write). The verb 'Read' and specific resource 'native annotations' provide a precise purpose.

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 explicitly states the constraint 'exactly one of pageId or nodeId is required' and mentions the optional includeCategories parameter. However, it does not provide explicit guidance on when to use this tool versus alternatives, though the read/write distinction with annotation_set is implied.

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/neozhehan/figma-edit-mcp'

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