OpenParable
Skip to content
← Back to skills

Figma Explore

Design
figma-explore

Figma Explore is an Agent Skill for design published in the bitovi/ai-enablement-prompts repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Explore a Figma file to discover all pages, components, and component sets using the Figma REST API. Use when you need to list components in a Figma file, find component node IDs for Code Connect, or understand the structure of a design file.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/bitovi/ai-enablement-prompts/blob/HEAD/figma/figma-explore/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/figma-explore, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: Explore Figma Files

This skill provides scripts to explore Figma files via the REST API, bypassing the limitations of the MCP tools which require a specific node ID.

When to Use This Skill

  • User provides a Figma file URL without a specific node ID
  • Need to discover all components in a Figma design system
  • Want to find component node IDs for Code Connect setup
  • Need to understand the page/component structure of a Figma file

Prerequisites

  1. FIGMA_ACCESS_TOKEN: Set in .env or environment

  2. Node.js: Version 18+ (for native fetch)

The Script: figma-extract-all.js

A single script that handles both discovery and full extraction with batched API requests.

Usage:

node <path-to-skills>/figma-explore/figma-extract-all.js <figmaFileUrl> [options]

Options:

OptionDescriptionDefault
--list-onlyQuick discovery only (1 API call)Full extraction
--output <dir>Output directory for JSON files.temp/figma-explore
--batch-size <n>Components per batch request30
--delay <ms>Delay between batches (rate limiting)1000

Quick Discovery (1 API call)

node <path-to-skills>/figma-explore/figma-extract-all.js <url> --list-only

Outputs JSON with component names, IDs, and URLs to stdout.

Full Extraction (batched)

node <path-to-skills>/figma-explore/figma-extract-all.js <url>

Writes to .temp/figma-explore/:

  • figma-components-index.json - Summary index
  • <component>.json - Full evidence per component

API Call Efficiency

Mode45 ComponentsAPI Calls
--list-only1 call✅ Instant
Full extraction1 + ⌈45/30⌉ = 3 calls✅ Batched

Execution Steps

Step 1: Verify Environment

Before running the script, ensure the token is available:

# Check if token is set
source .env 2>/dev/null
[ -n "$FIGMA_ACCESS_TOKEN" ] && echo "Token: set" || echo "Token: missing"

If not set:

  1. Create token at https://www.figma.com/developers/api#access-tokens
  2. Add to .env: FIGMA_ACCESS_TOKEN=figd_...

Step 2: Run Extraction

Quick discovery:

source .env && node <path-to-skills>/figma-explore/figma-extract-all.js "<figmaUrl>" --list-only

Full extraction:

source .env && node <path-to-skills>/figma-explore/figma-extract-all.js "<figmaUrl>"

Step 3: Use Results

Index file (.temp/figma-explore/figma-components-index.json):

{
  "fileName": "My Design System",
  "fileKey": "abc123DEF456",
  "totalComponents": 45,
  "components": [
    { "name": "Button", "id": "16:1234", "url": "..." }
  ]
}

Component evidence (.temp/figma-explore/button.json):

{
  "componentSetId": "16:1234",
  "componentName": "Button",
  "variantProperties": { "Size": ["Small", "Large"] },
  "componentProperties": [{ "name": "Disabled", "type": "BOOLEAN" }],
  "textLayers": [{ "name": "Label", "characters": "Button" }],
  "slotLayers": [{ "name": "Icon", "type": "INSTANCE" }]
}

Step 4: Generate Code Connect

Use the evidence files with:

  • The figma-connect-component skill
  • Direct Code Connect generation
  • Manual .figma.tsx file creation

Figma REST API Reference

The scripts use these endpoints:

EndpointPurpose
GET /v1/files/:file_keyGet entire file structure
GET /v1/files/:file_key/nodes?ids=:node_idsGet specific node details
GET /v1/files/:file_key/componentsList published components

Troubleshooting

401/403 Errors

404 Errors

  • File key is incorrect
  • You don't have access to the file
  • File has been deleted or moved

Network Errors

  • Check internet connection
  • Corporate proxy may need HTTP_PROXY/HTTPS_PROXY set