Skip to main content
Glama
yhc984

Talk to Figma MCP

by yhc984

get_document_info

Retrieve comprehensive details about the active Figma design document, including structure, elements, and metadata for analysis or integration.

Instructions

Get detailed information about the current Figma document

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Core implementation of get_document_info tool. Fetches and returns detailed information about the current Figma document/page including name, ID, type, children list, and page structure.
    async function getDocumentInfo() {
      await figma.currentPage.loadAsync();
      const page = figma.currentPage;
      return {
        name: page.name,
        id: page.id,
        type: page.type,
        children: page.children.map((node) => ({
          id: node.id,
          name: node.name,
          type: node.type,
        })),
        currentPage: {
          id: page.id,
          name: page.name,
          childCount: page.children.length,
        },
        pages: [
          {
            id: page.id,
            name: page.name,
            childCount: page.children.length,
          },
        ],
      };
    }
  • MCP tool registration for 'get_document_info'. Includes empty input schema ({}), description, and proxy handler that forwards the command to the Figma plugin via WebSocket and formats the response as MCP content.
    server.tool(
      "get_document_info",
      "Get detailed information about the current Figma document",
      {},
      async () => {
        try {
          const result = await sendCommandToFigma('get_document_info');
          return {
            content: [
              {
                type: "text",
                text: JSON.stringify(result, null, 2)
              }
            ]
          };
        } catch (error) {
          return {
            content: [
              {
                type: "text",
                text: `Error getting document info: ${error instanceof Error ? error.message : String(error)}`
              }
            ]
          };
        }
      }
    );
  • Input schema for get_document_info tool: empty object indicating no parameters required.
    "get_document_info",
    "Get detailed information about the current Figma document",
    {},
  • Dispatch case in handleCommand function that routes 'get_document_info' command to the getDocumentInfo handler.
    case "get_document_info":
      return await getDocumentInfo();
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It states it 'gets' information, implying a read-only operation, but doesn't disclose behavioral traits like whether it requires authentication, has rate limits, or what 'detailed information' entails (e.g., format, scope). This leaves gaps in understanding the tool's behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's front-loaded and appropriately sized, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 0 parameters and no output schema, the description is minimal but adequate for a simple read operation. However, with no annotations and siblings that overlap in purpose, it lacks completeness in guiding usage and behavioral context, making it just viable but with clear gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so no parameter information is needed. The description doesn't add param details, which is appropriate, but it could hint at implicit context (e.g., 'current' document). Since 0 params baseline is 4, this meets expectations without extra value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and the resource 'detailed information about the current Figma document', making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'get_node_info' or 'get_annotations', which also retrieve information but for different resources, so it falls short of a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'get_node_info' for specific nodes and 'get_annotations' for annotations, there's no indication of context or exclusions, leaving usage unclear beyond the basic purpose.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/yhc984/cursor-talk-to-figma-mcp-main'

If you have feedback or need assistance with the MCP directory API, please join our Discord server