You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Figma auth provider enables tools and agents to call [Figma APIs](https://www.figma.com/developers/api) on behalf of a user using OAuth 2.0 authentication.
5
+
The Figma auth provider enables tools and agents to call [Figma APIs](https://developers.figma.com/docs/rest-api/) on behalf of a user using OAuth 2.0 authentication.
6
6
7
7
<Callout>
8
8
Want to quickly get started with Figma in your agent or AI app? The pre-built
9
-
[Arcade Figma MCP Server](/mcp-servers/productivity/figma-api) is what you
9
+
[Arcade Figma MCP Server](/mcp-servers/development/figma) is what you
10
10
want!
11
11
</Callout>
12
12
@@ -16,10 +16,28 @@ This page describes how to use and configure Figma auth with Arcade.
16
16
17
17
This auth provider is used by:
18
18
19
-
- The [Arcade Figma MCP Server](/mcp-servers/productivity/figma-api), which provides pre-built tools for interacting with Figma
19
+
- The [Arcade Figma MCP Server](/mcp-servers/development/figma), which provides pre-built tools for interacting with Figma
20
20
- Your [app code](#using-figma-auth-in-app-code) that needs to call the Figma API
21
21
- Or, your [custom tools](#using-figma-auth-in-custom-tools) that need to call the Figma API
22
22
23
+
### Required scopes for the Figma MCP Server
24
+
25
+
If you're using the [Arcade Figma MCP Server](/mcp-servers/development/figma), you'll need to configure these scopes based on which tools you plan to use:
26
+
27
+
-`file_content:read` - File structure, pages, nodes, and image exports
28
+
-`library_content:read` - Published components, styles, and component sets from files
29
+
-`team_library_content:read` - Team library content
30
+
-`library_assets:read` - Individual component, style, and component set metadata
31
+
-`file_comments:read` / `file_comments:write` - Reading and creating comments
32
+
-`current_user:read` - User profile information
33
+
-`projects:read` - Team projects and files (**requires private OAuth app**)
34
+
35
+
<Callouttype="warning">
36
+
The `projects:read` scope is **only available in private Figma OAuth apps**. If you need to access team projects and files, you must create a private OAuth app through your Figma organization.
37
+
</Callout>
38
+
39
+
For detailed descriptions of all available Figma OAuth scopes, refer to the [Figma OAuth Scopes documentation](https://developers.figma.com/docs/rest-api/scopes/).
40
+
23
41
## Configuring Figma auth
24
42
25
43
<Callouttype="info">
@@ -57,10 +75,17 @@ Navigate to the [Figma Developer Portal](https://www.figma.com/developers/) and
57
75
58
76
1. After creating your app, you'll receive a `client_id` and `client_secret`
59
77
2. Set the redirect URI to the redirect URL generated by Arcade (see configuration section below)
60
-
3. Configure the required scopes for your application:
61
-
-`files:read` - Read access to files
78
+
3. Configure the required scopes for your application based on the tools you need:
79
+
-`file_content:read` - Read access to file content and structure
80
+
-`library_content:read` - Read access to published library content
81
+
-`team_library_content:read` - Read access to team library content
82
+
-`library_assets:read` - Read access to individual library assets
83
+
-`file_comments:read` - Read access to file comments
62
84
-`file_comments:write` - Write access to file comments
63
-
- Add other scopes as needed for your use case
85
+
-`current_user:read` - Read access to user profile
86
+
-`projects:read` - Read access to team projects (private apps only)
87
+
88
+
For a complete list of available scopes, refer to the [Figma OAuth Scopes documentation](https://developers.figma.com/docs/rest-api/scopes/)
64
89
65
90
</Steps>
66
91
@@ -89,12 +114,14 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
89
114
90
115
#### Enter the provider details
91
116
92
-
- Choose a unique **ID** for your provider (e.g. "arcade-figma").
117
+
- Choose a unique **ID** for your provider (e.g. "figma").
93
118
- Optionally enter a **Description**.
94
119
- Enter the **Client ID** and **Client Secret** from your Figma app.
**Note on `projects:read` scope:** If you need access to the `projects:read` scope for team projects and files navigation, you must create a **private Figma OAuth app**. This scope is not available in public OAuth apps. Learn more in the [Figma OAuth Scopes documentation](https://developers.figma.com/docs/rest-api/scopes/).
You can use the pre-built [Arcade Figma MCP Server](/mcp-servers/productivity/figma-api) to quickly build agents and AI apps that interact with Figma.
285
+
You can use the pre-built [Arcade Figma MCP Server](/mcp-servers/development/figma) to quickly build agents and AI apps that interact with Figma.
246
286
247
287
If the pre-built tools in the Figma MCP Server don't meet your needs, you can author your own [custom tools](/home/build-tools/create-a-mcp-server) that interact with the Figma API.
248
288
249
-
Use the `OAuth2()` auth class to specify that a tool requires authorization with Figma. The `context.authorization.token` field will be automatically populated with the user's Figma token:
289
+
Use the `Figma()` auth class to specify that a tool requires authorization with Figma. The `context.authorization.token` field will be automatically populated with the user's Figma token:
Figma supports various OAuth scopes that determine the level of access your application has:
286
-
287
-
-`files:read` - Read access to files
288
-
-`file_comments:write` - Write access to file comments
289
-
-`file_dev_resources:write` - Write access to dev resources
290
-
-`file_variables:read` - Read access to variables
291
-
-`file_variables:write` - Write access to variables
292
-
-`webhooks:write` - Write access to webhooks
293
-
294
-
For a complete list of available scopes and their descriptions, refer to the [Figma API documentation](https://www.figma.com/developers/api#authentication).
318
+
For a complete list of available Figma OAuth scopes and their descriptions, refer to the [Figma OAuth Scopes documentation](https://developers.figma.com/docs/rest-api/scopes/).
0 commit comments