Skip to main content
Glama
akari2600

figma-developer-docs-mcp

by akari2600
OverviewSchemaRelated ServersScoreDiscussions
TypeScript

Read Figma Developer Docs Index

read-figma-developer-docs-index

Discover available Figma developer documentation sections including Plugin API, Widget API, REST API, and more to identify specific pages for reading.

Instructions

Read the Figma developer documentation index. Returns all documentation sections (Plugin API, Widget API, REST API, Code Connect, Embeds, Figma MCP Server, Code/Make) with page listings. Use this first to discover what documentation is available, then use read-figma-developer-docs-pages to read specific pages.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/index.ts:63-88 (handler)
    Handler function for the 'read-figma-developer-docs-index' tool. It loads the documentation index and returns the sections and pages as JSON.
    async () => {
  const index = loadIndex();
  const sections = Object.entries(index.sections).map(
    ([name, section]) => ({
      section: name,
      pageCount: section.count,
      pages: section.pages.map((p) => ({
        path: p.path,
        title: p.title,
      })),
    })
  );

  return {
    content: [
      {
        type: "text" as const,
        text: JSON.stringify(
          { totalPages: index.totalPages, generatedAt: index.generatedAt, sections },
          null,
          2
        ),
      },
    ],
  };
}
  • src/index.ts:56-62 (registration)
    Registration of the 'read-figma-developer-docs-index' tool using the server.registerTool method.
    server.registerTool(
  "read-figma-developer-docs-index",
  {
    title: "Read Figma Developer Docs Index",
    description:
      "Read the Figma developer documentation index. Returns all documentation sections (Plugin API, Widget API, REST API, Code Connect, Embeds, Figma MCP Server, Code/Make) with page listings. Use this first to discover what documentation is available, then use read-figma-developer-docs-pages to read specific pages.",
  },

Tool Definition Quality

A4.4/5.0
Behavior3/5

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

With no annotations provided, the description carries full burden. It clearly indicates this is a read operation and describes the return content structure (all documentation sections with page listings). However, it doesn't disclose potential behavioral aspects like rate limits, authentication requirements, or error conditions that would be important for an agent to know.

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 perfectly concise with two well-structured sentences. The first sentence explains what the tool does, and the second provides crucial usage guidance. Every word earns its place with no redundancy or unnecessary information.

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?

For a zero-parameter read tool with no output schema, the description provides excellent context about what the tool returns and how it fits into a workflow with sibling tools. The main gap is the lack of output format details, but given the tool's simplicity and clear purpose, the description is nearly complete.

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 tool has zero parameters with 100% schema description coverage, so the baseline is 4. The description appropriately doesn't discuss parameters since none exist, focusing instead on the tool's purpose and usage context.

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 index'), and output ('all documentation sections with page listings'). It explicitly distinguishes this tool from its siblings by stating it should be used first to discover documentation before using read-figma-developer-docs-pages for specific pages.

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

Usage Guidelines5/5

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

The description provides explicit guidance on when to use this tool ('Use this first to discover what documentation is available') and when to use alternatives ('then use read-figma-developer-docs-pages to read specific pages'). It creates a clear workflow relationship with sibling tools.

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