Skip to Content

Figma

Figma icon
Arcade Optimized

Arcade tools designed for LLMs to interact with Figma

Author:Arcade
Version:0.1.0
Auth:User authorization via the Figma auth provider
15tools
PyPI VersionPython VersionsWheel StatusDownloadsLicense

Arcade provides a toolkit for LLMs to seamlessly interact with Figma, enabling users to automate design tasks and extract valuable data from Figma files.

Capabilities

  • Interact with Figma files, including reading content and comments.
  • Export images and retrieve component metadata efficiently.
  • Manage and fetch styles, components, and team projects in an organized manner.
  • Access user profiles and detailed file structures for enhanced design workflows.

OAuth

  • Provider: Figma
  • Scopes: current_user:read, file_comments:read, file_comments:write, file_content:read, library_assets:read, library_content:read, projects:read, team_library_content:read

Secrets

  • None.

Available tools(15)

15 of 15
Tool nameDescriptionSecrets
Add a comment to a Figma file or reply to an existing comment. If parent_comment_id is provided, creates a reply to that comment. Otherwise creates a new comment (optionally attached to a node).
Export Figma frames/nodes as images. Returns temporary URLs to download images. URLs valid for approximately 14 days.
Get comments on a Figma file. Returns comments with pagination support.
Get metadata for a specific component by its key.
Get published components from a file or team library. For file: Returns all published components in the file. For team: Returns paginated list of components across team library.
Get metadata for a specific component set by its key. A component set is a group of related component variants.
Get published component sets (groups of component variants) from a file or team library. Component sets are groups of related component variants, like a Button with states: default, hover, pressed, disabled. For file: Returns all published component sets in the file. For team: Returns paginated list of component sets across team library.
Get a Figma file's structure including pages and metadata. Returns the file name, version, thumbnail, and list of pages. Use depth parameter to limit how much of the tree is returned for large files.
Get specific nodes from a Figma file by their IDs. Returns the requested nodes with their properties and optionally their children. Use this to fetch specific parts of a file without loading the entire document.
Get a list of pages in a Figma file. Returns page IDs and names without the full node tree.
Get all files in a Figma project. Files are Figma design documents containing pages and frames.
Get metadata for a specific style by its key.
Get published styles from a file or team library. For file: Returns all published styles in the file. For team: Returns paginated list of styles across team library.
Get all projects in a Figma team. Projects are containers within a team that group related design files.
Get the authenticated user's profile.

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

Figma.AddCommentOrReply

Add a comment to a Figma file or reply to an existing comment. If parent_comment_id is provided, creates a reply to that comment. Otherwise creates a new comment (optionally attached to a node).

Parameters

ParameterTypeReq.Description
file_keystringRequiredFile key. Can be found in Figma URL: https://www.figma.com/file/{FILE_KEY}/...
messagestringRequiredThe comment or reply text.
parent_comment_idstringOptionalParent comment ID to reply to. If provided, creates a reply. Default is None.
node_idstringOptionalNode ID to attach the comment to. Ignored for replies. Default is None.
xnumberOptionalX position offset on the node. Only used with node_id. Default is None.
ynumberOptionalY position offset on the node. Only used with node_id. Default is None.

Requirements

No secrets required

Output

Type:jsonCreated comment or reply details
#

Figma.ExportImage

Export Figma frames/nodes as images. Returns temporary URLs to download images. URLs valid for approximately 14 days.

Parameters

ParameterTypeReq.Description
file_keystringRequiredFile key. Can be found in Figma URL: https://www.figma.com/file/{FILE_KEY}/...
node_idsarray<string>RequiredList of node IDs to export as images.
image_formatstringOptionalImage format. Default is png.
pngsvgpdfjpg
scalenumberOptionalScale factor (0.01 to 4.0). Only applies to PNG/JPG. Default is 1.0.

Requirements

No secrets required

Output

Type:jsonExported image URLs (temporary, ~14 days)
#

Figma.GetComments

Get comments on a Figma file. Returns comments with pagination support.

Parameters

ParameterTypeReq.Description
file_keystringRequiredFile key. Can be found in Figma URL: https://www.figma.com/file/{FILE_KEY}/...
offsetintegerOptionalStarting offset for pagination. Default is 0.
max_itemsintegerOptionalMaximum number of comments to return (1-50). Default is 10.

Requirements

No secrets required

Output

Type:jsonComments on the file
#

Figma.GetComponent

Get metadata for a specific component by its key.

Parameters

ParameterTypeReq.Description
component_keystringRequiredThe unique component key.

Requirements

No secrets required

Output

Type:jsonComponent metadata
#

Figma.GetComponents

Get published components from a file or team library. For file: Returns all published components in the file. For team: Returns paginated list of components across team library.

Parameters

ParameterTypeReq.Description
sourcestringRequiredSource type: 'file' for a specific file, 'team' for team library.
fileteam
source_idstringRequiredFile key (if source='file') or team ID (if source='team').
page_sizeintegerOptionalNumber of items per page (team mode only, 1-50). Default is 10.
after_cursorintegerOptionalCursor for next page (team mode only). Default is None.

Requirements

No secrets required

Output

Type:jsonPublished components from file or team library
#

Figma.GetComponentSet

Get metadata for a specific component set by its key. A component set is a group of related component variants.

Parameters

ParameterTypeReq.Description
component_set_keystringRequiredThe unique component set key.

Requirements

No secrets required

Output

Type:jsonComponent set metadata
#

Figma.GetComponentSets

Get published component sets (groups of component variants) from a file or team library. Component sets are groups of related component variants, like a Button with states: default, hover, pressed, disabled. For file: Returns all published component sets in the file. For team: Returns paginated list of component sets across team library.

Parameters

ParameterTypeReq.Description
sourcestringRequiredSource type: 'file' for a specific file, 'team' for team library.
fileteam
source_idstringRequiredFile key (if source='file') or team ID (if source='team').
page_sizeintegerOptionalNumber of items per page (team mode only, 1-50). Default is 10.
after_cursorintegerOptionalCursor for next page (team mode only). Default is None.

Requirements

No secrets required

Output

Type:jsonPublished component sets from file or team library
#

Figma.GetFile

Get a Figma file's structure including pages and metadata. Returns the file name, version, thumbnail, and list of pages. Use depth parameter to limit how much of the tree is returned for large files.

Parameters

ParameterTypeReq.Description
file_keystringRequiredFile key. Can be found in Figma URL: https://www.figma.com/file/{FILE_KEY}/...
depthintegerOptionalHow deep to traverse the node tree. Default traverses full depth. Use 1 for pages only, 2 for pages and top-level frames

Requirements

No secrets required

Output

Type:jsonFile structure with pages and metadata
#

Figma.GetFileNodes

Get specific nodes from a Figma file by their IDs. Returns the requested nodes with their properties and optionally their children. Use this to fetch specific parts of a file without loading the entire document.

Parameters

ParameterTypeReq.Description
file_keystringRequiredFile key. Can be found in Figma URL: https://www.figma.com/file/{FILE_KEY}/...
node_idsarray<string>RequiredList of node IDs to retrieve. Node IDs can be found in Figma URL after ?node-id= parameter (URL encoded, e.g., '0:1' or '1-2').
depthintegerOptionalHow deep to traverse from each node. Use 1 for direct children only. Default returns all descendants.

Requirements

No secrets required

Output

Type:jsonRequested nodes with their data
#

Figma.GetPages

Get a list of pages in a Figma file. Returns page IDs and names without the full node tree.

Parameters

ParameterTypeReq.Description
file_keystringRequiredFile key. Can be found in Figma URL: https://www.figma.com/file/{FILE_KEY}/...

Requirements

No secrets required

Output

Type:jsonList of pages in the file
#

Figma.GetProjectFiles

Get all files in a Figma project. Files are Figma design documents containing pages and frames.

Parameters

ParameterTypeReq.Description
project_idstringRequiredProject ID. Can be obtained from get_team_projects.

Requirements

No secrets required

Output

Type:jsonFiles in the specified project
#

Figma.GetStyle

Get metadata for a specific style by its key.

Parameters

ParameterTypeReq.Description
style_keystringRequiredThe unique style key.

Requirements

No secrets required

Output

Type:jsonStyle metadata
#

Figma.GetStyles

Get published styles from a file or team library. For file: Returns all published styles in the file. For team: Returns paginated list of styles across team library.

Parameters

ParameterTypeReq.Description
sourcestringRequiredSource type: 'file' for a specific file, 'team' for team library.
fileteam
source_idstringRequiredFile key (if source='file') or team ID (if source='team').
page_sizeintegerOptionalNumber of items per page (team mode only, 1-50). Default is 10.
after_cursorintegerOptionalCursor for next page (team mode only). Default is None.

Requirements

No secrets required

Output

Type:jsonPublished styles from file or team library
#

Figma.GetTeamProjects

Get all projects in a Figma team. Projects are containers within a team that group related design files.

Parameters

ParameterTypeReq.Description
team_idstringRequiredTeam ID. Can be found in Figma URL: https://www.figma.com/files/team/{TEAM_ID}/...

Requirements

No secrets required

Output

Type:jsonProjects in the specified team
#

Figma.WhoAmI

Get the authenticated user's profile.

Parameters

No parameters required.

Requirements

No secrets required

Output

Type:jsonAuthenticated user's profile.
Last updated on