`get_file`

Pack: figma · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/get_file for the schema, then POST the same URL with its arguments for the data.

Get a compact summary of a Figma design file by its file key: name, last modified time, version, editor type, role, thumbnail URL, and the list of top-level pages (id, name, type, child count). Use to understand the structure of a Figma design file without fetching the full node tree.

Parameters

Name	Type	Required	Description
`file_key`	string	yes	The Figma file key (the segment after /file/ or /design/ in a Figma URL).
`depth`	number	no	How many levels of the document tree to traverse (default 2). Lower values return less data.

Example call

Arguments

{
  "file_key": "abc123xyz"
}

curl

curl -X POST https://gateway.pipeworx.io/figma/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_file","arguments":{"file_key":"abc123xyz"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('get_file', {
  "file_key": "abc123xyz"
});

More examples

{
  "file_key": "abc123xyz",
  "depth": 3
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

{
  "mcpServers": {
    "pipeworx": {
      "url": "https://pipeworx.io/mcp"
    }
  }
}

Connect to just the figma pack

{
  "mcpServers": {
    "figma": {
      "url": "https://gateway.pipeworx.io/figma/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

get_file