Read a Figma kit
read-figma-kitExtracts a Figma file's variables, styles, and component variant options into one JSON kit and returns counts, so agents can reuse the client's design system.
Instructions
Reads the design kit in the Figma file the designer has open: every variable in every mode, the text and effect styles, and every component with the options of its variant properties. Writes them as one JSON file and returns the counts. The Better Design plugin must be open in that file, and the designer confirms the read in the plugin panel. Only the file's own items are read; a library the file uses is read from its own file. Pass a projectId to also keep the kit on that Better Design project, so later calls build with the client's own names and values.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | No | A Better Design project id. The kit is kept on it, replacing the one it held. | |
| outputPath | Yes | Where to write the kit JSON. Relative paths resolve against the working directory. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | No | ||
| gaps | No | ||
| path | No | ||
| status | Yes | ||
| message | Yes | ||
| nameMap | No | ||
| projectId | No | ||
| variables | No | ||
| components | No | ||
| textStyles | No | ||
| collections | No | ||
| effectStyles | No |