View as Markdown
Figma icon

Figma ACTION

List Comments

Lists all comments left on a file. See the docs here
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Figma account once, then configure and run List Comments from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "figma-list-comments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    figma: { authProvisionId: "apn_xxxxxxx" },
    projectId: "Project Id",
    fileId: "File Id",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Comments inputs
Property Type Description
projectId Project Id string
Navigate to your project in Figma. You can find your Project ID in the URL between /project/ and the project name. For example, if your project URL is https://www.figma.com/files/team/1562118717370912711/project/478297666/Team-project?fuid=1562118714608714352, enter 478297666 here.
Required
fileId File Id string
Navigate to your file in Figma and open it. You can find your File ID in the URL after /file/. For example, if your file URL is https://www.figma.com/file/ABC123xyz456/My-Design-File, enter ABC123xyz456 here.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
figma-list-comments
Version
0.0.6
App
Figma
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes