Skip to main content
Glama
akari2600

figma-developer-docs-mcp

by akari2600

Read Figma Developer Docs Pages

read-figma-developer-docs-pages

Retrieve Figma developer documentation pages by specifying paths to access Plugin, Widget, and REST API content for development tasks.

Instructions

Read specific pages of the Figma developer documentation. Provide page paths from the index (e.g., '/docs/plugins/api/TextNode', '/docs/rest-api/authentication'). Returns the full markdown content of each requested page. You can request multiple pages at once.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathsYesArray of documentation page paths to read (e.g., ['/docs/plugins/api/TextNode', '/docs/plugins/working-with-text'])

Implementation Reference

  • Implementation of the "read-figma-developer-docs-pages" tool, which retrieves markdown content for specified documentation page paths.
    server.registerTool(
      "read-figma-developer-docs-pages",
      {
        title: "Read Figma Developer Docs Pages",
        description:
          "Read specific pages of the Figma developer documentation. Provide page paths from the index (e.g., '/docs/plugins/api/TextNode', '/docs/rest-api/authentication'). Returns the full markdown content of each requested page. You can request multiple pages at once.",
        inputSchema: {
          paths: z
            .array(z.string())
            .describe(
              "Array of documentation page paths to read (e.g., ['/docs/plugins/api/TextNode', '/docs/plugins/working-with-text'])"
            ),
        },
      },
      async ({ paths }) => {
        const results: string[] = [];
    
        for (const path of paths) {
          const content = loadPage(path);
          if (content) {
            results.push(`--- Page: ${path} ---\n\n${content}`);
          } else {
            results.push(
              `--- Page: ${path} ---\n\nPage not found. Use read-figma-developer-docs-index to see available pages.`
            );
          }
        }
    
        return {
          content: [{ type: "text" as const, text: results.join("\n\n") }],
        };
      }
    );
  • Helper function used by the tool to read a specific markdown file from the documentation directory based on a given path.
    function loadPage(docPath: string): string | null {
      let normalizedPath = docPath.startsWith("/") ? docPath : "/" + docPath;
      normalizedPath = normalizedPath.replace(/\/$/, "");
      if (!normalizedPath) normalizedPath = "/index";
    
      const filePath = join(DOCS_DIR, normalizedPath + ".md");
      if (!existsSync(filePath)) return null;
      return readFileSync(filePath, "utf-8");
    }
Behavior3/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 discloses key behavioral traits: it returns 'full markdown content' and supports 'multiple pages at once'. However, it doesn't mention error handling (e.g., what happens if a path is invalid), rate limits, authentication requirements, or pagination. For a read operation with no annotations, this is adequate but leaves gaps in behavioral understanding.

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 three sentences with zero waste: first sentence states the purpose, second specifies the return format, third adds the multi-page capability. It's front-loaded with the core functionality and efficiently conveys all necessary information without redundancy.

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

Completeness4/5

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

Given the tool's low complexity (single parameter, read-only operation), no annotations, and no output schema, the description is reasonably complete. It covers purpose, input examples, return format, and multi-page support. However, it lacks details on error cases or response structure, which would be helpful for a tool with no output schema. It's mostly adequate but could be more comprehensive.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already fully documents the single parameter 'paths'. The description adds minimal value beyond the schema: it provides example paths ('/docs/plugins/api/TextNode', '/docs/rest-api/authentication') and clarifies that you can 'request multiple pages at once', which is implied by the array type in the schema. Baseline 3 is appropriate since the schema does the heavy lifting.

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

Purpose5/5

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

The description clearly states the specific action ('Read'), resource ('Figma developer documentation pages'), and scope ('specific pages'). It distinguishes from the sibling 'read-figma-developer-docs-index' (which presumably reads the index) and 'search-figma-developer-docs' (which searches rather than reading specific pages). The verb+resource combination is precise and unambiguous.

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

Usage Guidelines4/5

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

The description provides clear context on when to use this tool: for reading specific documentation pages when you know the exact paths. It implies an alternative (the sibling 'search-figma-developer-docs' for when you don't know the exact paths), but doesn't explicitly name it or state when not to use this tool. The guidance is helpful but not fully explicit about alternatives.

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/akari2600/figma-developer-docs-mcp'

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