> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Figma

> A collaborative interface design tool

A collaborative interface design tool.

`figma` · **53 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth figma
run auth figma --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run figma          # common commands
run figma --all    # every command
```

```ts theme={"theme":"github-dark"}
import { figma } from "@boxd/run";
```

## Common tools

| Tool                             | What it does                                                                                                                                                     |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `design-tokens-to-tailwind`      | Convert design tokens to Tailwind CSS configuration. TWO-STEP WORKFLOW: 1.                                                                                       |
| `download-images`                | Download images from Figma file nodes. Renders specified nodes as images and downloads them.                                                                     |
| `extract-design-tokens`          | Extract design tokens from Figma files by combining styles, variables, and node-extracted values.                                                                |
| `extract-prototype-interactions` | Extract prototype interactions and animations from Figma files.                                                                                                  |
| `get-component`                  | DEPRECATED: Use FIGMA\_GET\_FILE\_NODES instead. Get component data with automatic simplification.                                                               |
| `get-component2`                 | Fetches metadata for a specific component using its unique identifier.                                                                                           |
| `get-current-user`               | Retrieves detailed information for the currently authenticated Figma user.                                                                                       |
| `get-file-components`            | Retrieves published components from a Figma file, which must be a main file (not a branch) acting as a library.                                                  |
| `get-file-component-sets`        | Retrieves all published component sets from the specified Figma main file (file\_key must not be for a branch).                                                  |
| `get-file-json`                  | Get Figma Design file data with automatic simplification. IMPORTANT: Only supports Design files (figma.com/design/\{file\_key}).                                 |
| `get-file-metadata`              | Get Figma file metadata including name, creator, last modification details, thumbnail, and access information.                                                   |
| `get-file-nodes`                 | Fetch JSON for specific node IDs from a Figma file to avoid full-file payload limits.                                                                            |
| `get-files-in-project`           | Fetches a list of files in a Figma project, optionally including branch metadata.                                                                                |
| `get-local-variables`            | Retrieves all local/remote variables for a Figma file/branch; crucial for obtaining mode-specific values which `/v1/files/{file_key}/variables/published` omits. |
| `get-projects-in-team`           | Retrieves projects within a specified Figma team that are visible to the authenticated user.                                                                     |

<Accordion title="All 53 tools" icon="list">
  | Tool                                          | What it does                                                                                                                                                          |
  | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `add-comment-to-file`                         | Posts a new comment to a Figma file or branch, optionally replying to an existing root comment (replies cannot be nested); `region_height` and...                     |
  | `add-reaction-to-comment`                     | Posts a specified emoji reaction to an existing comment in a Figma file or branch, requiring valid file\_key and comment\_id.                                         |
  | `create-webhook`                              | Creates a Figma webhook to receive POST notifications when specific events occur.                                                                                     |
  | `create-dev-resources`                        | Creates and attaches multiple uniquely-URLed development resources to specified Figma nodes, up to 10 per node.                                                       |
  | `create-modify-delete-variables`              | Manages variables, collections, modes, and their values in a Figma file via batch create/update/delete operations; use temporary IDs to link new\...                  |
  | `delete-comment`                              | Deletes a specific comment from a Figma file or branch, provided the authenticated user is the original author of the comment.                                        |
  | `delete-reaction`                             | Deletes a specific emoji reaction from a comment in a Figma file; the user must have originally created the reaction.                                                 |
  | `delete-webhook`                              | Permanently deletes an existing webhook, identified by its unique `webhook_id`; this operation is irreversible.                                                       |
  | `delete-dev-resource`                         | Deletes a development resource (used to link Figma design elements to external developer information like code or tasks) from a specified Figma file.                 |
  | `design-tokens-to-tailwind`                   | Convert design tokens to Tailwind CSS configuration. TWO-STEP WORKFLOW: 1.                                                                                            |
  | `detect-background`                           | Detect background layers for selected nodes in a Figma file.                                                                                                          |
  | `discover-resources`                          | Smart Figma resource discovery - extract IDs from any Figma URL.                                                                                                      |
  | `download-images`                             | Download images from Figma file nodes. Renders specified nodes as images and downloads them.                                                                          |
  | `extract-design-tokens`                       | Extract design tokens from Figma files by combining styles, variables, and node-extracted values.                                                                     |
  | `extract-prototype-interactions`              | Extract prototype interactions and animations from Figma files.                                                                                                       |
  | `get-activity-logs`                           | Retrieves activity log events from Figma, allowing filtering by event types, time range, and pagination.                                                              |
  | `get-webhook`                                 | Retrieves detailed information about a specific webhook by its ID, provided the webhook exists and is accessible to the user.                                         |
  | `get-comments-in-file`                        | Retrieves all comments from an existing Figma file, identified by a valid `file_key`, returning details like content, author, position, and...                        |
  | `get-component`                               | DEPRECATED: Use FIGMA\_GET\_FILE\_NODES instead. Get component data with automatic simplification.                                                                    |
  | `get-component2`                              | Fetches metadata for a specific component using its unique identifier.                                                                                                |
  | `get-component-set`                           | Retrieves detailed metadata for a specific published Figma component set using its unique `key`.                                                                      |
  | `get-current-user`                            | Retrieves detailed information for the currently authenticated Figma user.                                                                                            |
  | `get-dev-resources`                           | Retrieves development resources (e.g., Jira/GitHub links) for a Figma main file, optionally filtering by specific node IDs.                                           |
  | `get-file-components`                         | Retrieves published components from a Figma file, which must be a main file (not a branch) acting as a library.                                                       |
  | `get-file-component-sets`                     | Retrieves all published component sets from the specified Figma main file (file\_key must not be for a branch).                                                       |
  | `get-file-json`                               | Get Figma Design file data with automatic simplification. IMPORTANT: Only supports Design files (figma.com/design/\{file\_key}).                                      |
  | `get-file-metadata`                           | Get Figma file metadata including name, creator, last modification details, thumbnail, and access information.                                                        |
  | `get-file-nodes`                              | Fetch JSON for specific node IDs from a Figma file to avoid full-file payload limits.                                                                                 |
  | `get-files-in-project`                        | Fetches a list of files in a Figma project, optionally including branch metadata.                                                                                     |
  | `get-file-styles`                             | Retrieves a list of published styles (like colors, text attributes, effects, and layout grids) from a specified main Figma file (not a branch).                       |
  | `get-image-fills`                             | Retrieves temporary (14-day expiry) download URLs for all image fills in a Figma file; requires `imageRef` from `Paint` objects to map URLs.                          |
  | `get-library-analytics-component-action-data` | Retrieves component insertion and detachment analytics for a specified Figma library, groupable by 'component' or 'team' and filterable by a date range (YYYY-MM-DD). |
  | `get-library-analytics-component-usage-data`  | Retrieves component usage analytics for a specified Figma library file (identified by `file_key`), with data groupable by 'component' or 'file'.                      |
  | `get-library-analytics-style-action-data`     | Retrieves style usage analytics (insertions, detachments) for a Figma library, grouped by 'style' or 'team'; if providing a date range, ensure...                     |
  | `get-library-analytics-style-usage-data`      | Retrieves style usage analytics for a published Figma library.                                                                                                        |
  | `get-library-analytics-variable-action-data`  | Retrieves weekly, paginated analytics data on variable insertions and detachments for a specified Figma library (identified by `file_key`), groupable...              |
  | `get-library-analytics-variable-usage-data`   | Retrieves paginated analytics data on variable usage from a specified Figma library, grouped by 'file' or 'variable', for libraries with enabled analytics.           |
  | `get-local-variables`                         | Retrieves all local/remote variables for a Figma file/branch; crucial for obtaining mode-specific values which `/v1/files/{file_key}/variables/published` omits.      |
  | `get-payments`                                | Retrieves a user's payment information for a Figma plugin, widget, or Community file; the authenticated identity must own the resource.                               |
  | `get-projects-in-team`                        | Retrieves projects within a specified Figma team that are visible to the authenticated user.                                                                          |
  | `get-published-variables`                     | Retrieves variables published from a specified Figma file; this API is available only to full members of Enterprise organizations.                                    |
  | `get-reactions-for-comment`                   | Retrieves reactions for a specific comment in a Figma file.                                                                                                           |
  | `get-scim-service-provider-config`            | Get Figma's SCIM service provider configuration. Returns configuration details including which SCIM operations are supported (patch, bulk, filter...                  |
  | `get-style`                                   | Retrieves detailed metadata for a specific style in Figma using its unique style key.                                                                                 |
  | `get-team-components`                         | Retrieves components published in a specific Figma team's library; the team must have published components, otherwise an empty list is returned.                      |
  | `get-team-component-sets`                     | Retrieves a paginated list of published component sets (collections of reusable UI elements) from a specified Figma team's library.                                   |
  | `get-team-styles`                             | Retrieves a paginated list of published styles (fill colors, text styles, effects, grids) from a specified Figma team's library.                                      |
  | `get-team-webhooks`                           | Retrieves all webhooks registered for a specified Figma context (team, project, or file).                                                                             |
  | `get-versions-of-file`                        | Retrieves the version history for a Figma file or branch, as specified by its `file_key`.                                                                             |
  | `get-webhook-requests`                        | Retrieves a history of webhook requests for a specific Figma webhook subscription; data is available for requests sent within the last seven days.                    |
  | `render-images-of-file-nodes`                 | Render Figma nodes as images (PNG, JPG, SVG, PDF). Returns a map of node IDs to temporary image URLs (valid for 30 days).                                             |
  | `update-webhook`                              | Updates an existing Figma webhook, identified by `webhook_id`, allowing modification of its event type, endpoint, passcode, status, or description.                   |
  | `update-dev-resources`                        | Updates the name and/or URL of one or more existing Figma Dev Resources, each identified by its unique `id`.                                                          |
</Accordion>

[Open Figma in the console →](https://app.boxd.sh/integrations/detail/figma)
