figma_index
Index a page or subtree in document order to map node IDs, names, types, and hierarchy before inspecting details. Read-only and bounded by maxNodes, so it flags truncation.
Instructions
A compact flat index of a page or subtree, in document order: id, stable key, name, type, path, depth, visibility, size, child count, and the build root when the node is inside a figma_build/patch tree. Use it to find the shape of a page before inspecting one subtree. Read-only; stops at maxNodes and says so rather than returning a partial index that looks complete.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "figma_index"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fileKey | No | Which connected Figma file to use: its fileKey (figma_whoami) or, when omitted, the only connected file. Required once more than one file is connected; figma_ping lists them. | |
| maxDepth | No | 0 = root only; omitted = the whole subtree | |
| maxNodes | No | Stop after this many visible nodes | |
| rootNodeId | No | Subtree root; defaults to the current page | |
| includeText | No | Include a 160-character text preview for TEXT nodes | |
| includeHidden | No | Index hidden layers too |